class StyleSerializerTest in Drupal 9

Same name and namespace in other branches

8 core/modules/rest/tests/src/Functional/Views/StyleSerializerTest.php \Drupal\Tests\rest\Functional\Views\StyleSerializerTest

Tests the serializer style plugin.

@group rest

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\views\Functional\ViewTestBase uses ViewResultAssertionTrait
  - class \Drupal\Tests\rest\Functional\Views\StyleSerializerTest uses AssertPageCacheContextsAndTagsTrait

Expanded class hierarchy of StyleSerializerTest

File

core/modules/rest/tests/src/Functional/Views/StyleSerializerTest.php, line 30

Namespace

Drupal\Tests\rest\Functional\Views

View source

class StyleSerializerTest extends ViewTestBase {
  use AssertPageCacheContextsAndTagsTrait;

  /**
   * Modules to install.
   *
   * @var array
   */
  protected static $modules = [
    'views_ui',
    'entity_test',
    'hal',
    'rest_test_views',
    'node',
    'text',
    'field',
    'language',
    'basic_auth',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_serializer_display_field',
    'test_serializer_display_entity',
    'test_serializer_display_entity_translated',
    'test_serializer_node_display_field',
    'test_serializer_node_exposed_filter',
    'test_serializer_shared_path',
  ];

  /**
   * A user with administrative privileges to look at test entity and configure views.
   */
  protected $adminUser;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;
  protected function setUp($import_test_views = TRUE) : void {
    parent::setUp($import_test_views);
    ViewTestData::createTestViews(static::class, [
      'rest_test_views',
    ]);
    $this->adminUser = $this
      ->drupalCreateUser([
      'administer views',
      'administer entity_test content',
      'access user profiles',
      'view test entity',
    ]);

    // Save some entity_test entities.
    for ($i = 1; $i <= 10; $i++) {
      EntityTest::create([
        'name' => 'test_' . $i,
        'user_id' => $this->adminUser
          ->id(),
      ])
        ->save();
    }
    $this
      ->enableViewsTestModule();
    $this->renderer = \Drupal::service('renderer');
  }

  /**
   * Checks that the auth options restricts access to a REST views display.
   */
  public function testRestViewsAuthentication() {

    // Assume the view is hidden behind a permission.
    $this
      ->drupalGet('test/serialize/auth_with_perm', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(401);

    // Not even logging in would make it possible to see the view, because then
    // we are denied based on authentication method (cookie).
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('test/serialize/auth_with_perm', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $this
      ->drupalLogout();

    // But if we use the basic auth authentication strategy, we should be able
    // to see the page.
    $url = $this
      ->buildUrl('test/serialize/auth_with_perm');
    $response = \Drupal::httpClient()
      ->get($url, [
      'auth' => [
        $this->adminUser
          ->getAccountName(),
        $this->adminUser->pass_raw,
      ],
      'query' => [
        '_format' => 'json',
      ],
    ]);

    // Ensure that any changes to variables in the other thread are picked up.
    $this
      ->refreshVariables();
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Checks the behavior of the Serializer callback paths and row plugins.
   */
  public function testSerializerResponses() {

    // Test the serialize callback.
    $view = Views::getView('test_serializer_display_field');
    $view
      ->initDisplay();
    $this
      ->executeView($view);
    $actual_json = $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertCacheTags($view
      ->getCacheTags());
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'theme',
      'request_format',
    ]);

    // @todo Due to https://www.drupal.org/node/2352009 we can't yet test the
    // propagation of cache max-age.
    // Test the http Content-type.
    $headers = $this
      ->getSession()
      ->getResponseHeaders();
    $this
      ->assertSame([
      'application/json',
    ], $headers['Content-Type']);
    $expected = [];
    foreach ($view->result as $row) {
      $expected_row = [];
      foreach ($view->field as $id => $field) {
        $expected_row[$id] = $field
          ->render($row);
      }
      $expected[] = $expected_row;
    }
    $this
      ->assertSame(json_encode($expected), $actual_json, 'The expected JSON output was found.');

    // Test that the rendered output and the preview output are the same.
    $view
      ->destroy();
    $view
      ->setDisplay('rest_export_1');

    // Mock the request content type by setting it on the display handler.
    $view->display_handler
      ->setContentType('json');
    $output = $view
      ->preview();
    $this
      ->assertSame((string) $this->renderer
      ->renderRoot($output), $actual_json, 'The expected JSON preview output was found.');

    // Test a 403 callback.
    $this
      ->drupalGet('test/serialize/denied', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(403);

    // Test the entity rows.
    $view = Views::getView('test_serializer_display_entity');
    $view
      ->initDisplay();
    $this
      ->executeView($view);

    // Get the serializer service.
    $serializer = $this->container
      ->get('serializer');
    $entities = [];
    foreach ($view->result as $row) {
      $entities[] = $row->_entity;
    }
    $expected = $serializer
      ->serialize($entities, 'json');
    $actual_json = $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSame($expected, $actual_json, 'The expected JSON output was found.');
    $expected_cache_tags = $view
      ->getCacheTags();
    $expected_cache_tags[] = 'entity_test_list';

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    foreach ($entities as $entity) {
      $expected_cache_tags = Cache::mergeTags($expected_cache_tags, $entity
        ->getCacheTags());
    }
    $this
      ->assertCacheTags($expected_cache_tags);
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'theme',
      'entity_test_view_grants',
      'request_format',
    ]);
    $expected = $serializer
      ->serialize($entities, 'hal_json');
    $actual_json = $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'hal_json',
      ],
    ]);
    $this
      ->assertSame($expected, $actual_json, 'The expected HAL output was found.');
    $this
      ->assertCacheTags($expected_cache_tags);

    // Change the format to xml.
    $view
      ->setDisplay('rest_export_1');
    $view
      ->getDisplay()
      ->setOption('style', [
      'type' => 'serializer',
      'options' => [
        'uses_fields' => FALSE,
        'formats' => [
          'xml' => 'xml',
        ],
      ],
    ]);
    $view
      ->save();
    $expected = $serializer
      ->serialize($entities, 'xml');
    $actual_xml = $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->assertSame(trim($expected), $actual_xml);
    $this
      ->assertCacheContexts([
      'languages:language_interface',
      'theme',
      'entity_test_view_grants',
      'request_format',
    ]);

    // Allow multiple formats.
    $view
      ->setDisplay('rest_export_1');
    $view
      ->getDisplay()
      ->setOption('style', [
      'type' => 'serializer',
      'options' => [
        'uses_fields' => FALSE,
        'formats' => [
          'xml' => 'xml',
          'json' => 'json',
        ],
      ],
    ]);
    $view
      ->save();
    $expected = $serializer
      ->serialize($entities, 'json');
    $actual_json = $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSame($expected, $actual_json, 'The expected JSON output was found.');
    $expected = $serializer
      ->serialize($entities, 'xml');
    $actual_xml = $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->assertSame(trim($expected), $actual_xml);
  }

  /**
   * Verifies REST export views work on the same path as a page display.
   */
  public function testSharedPagePath() {

    // Test with no format as well as html explicitly.
    $this
      ->drupalGet('test/serialize/shared');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/html; charset=UTF-8');
    $this
      ->drupalGet('test/serialize/shared', [
      'query' => [
        '_format' => 'html',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/html; charset=UTF-8');
    $this
      ->drupalGet('test/serialize/shared', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->drupalGet('test/serialize/shared', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/xml; charset=UTF-8');
  }

  /**
   * Verifies site maintenance mode functionality.
   */
  public function testSiteMaintenance() {
    $view = Views::getView('test_serializer_display_field');
    $view
      ->initDisplay();
    $this
      ->executeView($view);

    // Set the site to maintenance mode.
    $this->container
      ->get('state')
      ->set('system.maintenance_mode', TRUE);
    $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]);

    // Verify that the endpoint is unavailable for anonymous users.
    $this
      ->assertSession()
      ->statusCodeEquals(503);
  }

  /**
   * Sets up a request on the request stack with a specified format.
   *
   * @param string $format
   *   The new request format.
   */
  protected function addRequestWithFormat($format) {
    $request = \Drupal::request();
    $request = clone $request;
    $request
      ->setRequestFormat($format);
    \Drupal::requestStack()
      ->push($request);
  }

  /**
   * Tests REST export with views render caching enabled.
   */
  public function testRestRenderCaching() {
    $this
      ->drupalLogin($this->adminUser);

    /** @var \Drupal\Core\Render\RenderCacheInterface $render_cache */
    $render_cache = \Drupal::service('render_cache');

    // Enable render caching for the views.

    /** @var \Drupal\views\ViewEntityInterface $storage */
    $storage = View::load('test_serializer_display_entity');
    $options =& $storage
      ->getDisplay('default');
    $options['display_options']['cache'] = [
      'type' => 'tag',
    ];
    $storage
      ->save();
    $original = DisplayPluginBase::buildBasicRenderable('test_serializer_display_entity', 'rest_export_1');

    // Ensure that there is no corresponding render cache item yet.
    $original['#cache'] += [
      'contexts' => [],
    ];
    $original['#cache']['contexts'] = Cache::mergeContexts($original['#cache']['contexts'], $this->container
      ->getParameter('renderer.config')['required_cache_contexts']);
    $cache_tags = [
      'config:views.view.test_serializer_display_entity',
      'entity_test:1',
      'entity_test:10',
      'entity_test:2',
      'entity_test:3',
      'entity_test:4',
      'entity_test:5',
      'entity_test:6',
      'entity_test:7',
      'entity_test:8',
      'entity_test:9',
      'entity_test_list',
    ];
    $cache_contexts = [
      'entity_test_view_grants',
      'languages:language_interface',
      'theme',
      'request_format',
    ];
    $this
      ->assertFalse($render_cache
      ->get($original));

    // Request the page, once in XML and once in JSON to ensure that the caching
    // varies by it.
    $result1 = Json::decode($this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $this
      ->addRequestWithFormat('json');
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertCacheContexts($cache_contexts);
    $this
      ->assertCacheTags($cache_tags);
    $this
      ->assertNotEmpty($render_cache
      ->get($original));
    $result_xml = $this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->addRequestWithFormat('xml');
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/xml; charset=UTF-8');
    $this
      ->assertCacheContexts($cache_contexts);
    $this
      ->assertCacheTags($cache_tags);
    $this
      ->assertNotEmpty($render_cache
      ->get($original));

    // Ensure that the XML output is different from the JSON one.
    $this
      ->assertNotEquals($result1, $result_xml);

    // Ensure that the cached page works.
    $result2 = Json::decode($this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $this
      ->addRequestWithFormat('json');
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertEquals($result1, $result2);
    $this
      ->assertCacheContexts($cache_contexts);
    $this
      ->assertCacheTags($cache_tags);
    $this
      ->assertNotEmpty($render_cache
      ->get($original));

    // Create a new entity and ensure that the cache tags are taken over.
    EntityTest::create([
      'name' => 'test_11',
      'user_id' => $this->adminUser
        ->id(),
    ])
      ->save();
    $result3 = Json::decode($this
      ->drupalGet('test/serialize/entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $this
      ->addRequestWithFormat('json');
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertNotEquals($result2, $result3);

    // Add the new entity cache tag and remove the first one, because we just
    // show 10 items in total.
    $cache_tags[] = 'entity_test:11';
    unset($cache_tags[array_search('entity_test:1', $cache_tags)]);
    $this
      ->assertCacheContexts($cache_contexts);
    $this
      ->assertCacheTags($cache_tags);
    $this
      ->assertNotEmpty($render_cache
      ->get($original));
  }

  /**
   * Tests the response format configuration.
   */
  public function testResponseFormatConfiguration() {
    $this
      ->drupalLogin($this->adminUser);
    $style_options = 'admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/style_options';

    // Ensure a request with no format returns 406 Not Acceptable.
    $this
      ->drupalGet('test/serialize/field');
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/html; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(406);

    // Select only 'xml' as an accepted format.
    $this
      ->drupalGet($style_options);
    $this
      ->submitForm([
      'style_options[formats][xml]' => 'xml',
    ], 'Apply');
    $this
      ->submitForm([], 'Save');

    // Ensure a request for JSON returns 406 Not Acceptable.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(406);

    // Ensure a request for XML returns 200 OK.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/xml; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Add 'json' as an accepted format, so we have multiple.
    $this
      ->drupalGet($style_options);
    $this
      ->submitForm([
      'style_options[formats][json]' => 'json',
    ], 'Apply');
    $this
      ->submitForm([], 'Save');

    // Should return a 406. Emulates a sample Firefox header.
    $this
      ->drupalGet('test/serialize/field', [], [
      'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/html; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(406);

    // Ensure a request for HTML returns 406 Not Acceptable.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'html',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/html; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(406);

    // Ensure a request for JSON returns 200 OK.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Ensure a request XML returns 200 OK.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/xml; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Now configure no format, so both serialization formats should be allowed.
    $this
      ->drupalGet($style_options);
    $this
      ->submitForm([
      'style_options[formats][json]' => '0',
      'style_options[formats][xml]' => '0',
    ], 'Apply');

    // Ensure a request for JSON returns 200 OK.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'application/json');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Ensure a request for XML returns 200 OK.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'xml',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/xml; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Should return a 406 for HTML still.
    $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'html',
      ],
    ]);
    $this
      ->assertSession()
      ->responseHeaderEquals('content-type', 'text/html; charset=UTF-8');
    $this
      ->assertSession()
      ->statusCodeEquals(406);
  }

  /**
   * Tests the field ID alias functionality of the DataFieldRow plugin.
   */
  public function testUIFieldAlias() {
    $this
      ->drupalLogin($this->adminUser);

    // Test the UI settings for adding field ID aliases.
    $this
      ->drupalGet('admin/structure/views/view/test_serializer_display_field/edit/rest_export_1');
    $row_options = 'admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/row_options';
    $this
      ->assertSession()
      ->linkByHrefExists($row_options);

    // Test an empty string for an alias, this should not be used. This also
    // tests that the form can be submitted with no aliases.
    $this
      ->drupalGet($row_options);
    $this
      ->submitForm([
      'row_options[field_options][name][alias]' => '',
    ], 'Apply');
    $this
      ->submitForm([], 'Save');
    $view = Views::getView('test_serializer_display_field');
    $view
      ->setDisplay('rest_export_1');
    $this
      ->executeView($view);
    $expected = [];
    foreach ($view->result as $row) {
      $expected_row = [];
      foreach ($view->field as $id => $field) {
        $expected_row[$id] = $field
          ->render($row);
      }
      $expected[] = $expected_row;
    }
    $this
      ->assertEquals($expected, Json::decode($this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ])));

    // Test a random aliases for fields, they should be replaced.
    $alias_map = [
      'name' => $this
        ->randomMachineName(),
      // Use # to produce an invalid character for the validation.
      'nothing' => '#' . $this
        ->randomMachineName(),
      'created' => 'created',
    ];
    $edit = [
      'row_options[field_options][name][alias]' => $alias_map['name'],
      'row_options[field_options][nothing][alias]' => $alias_map['nothing'],
    ];
    $this
      ->drupalGet($row_options);
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->assertSession()
      ->pageTextContains('The machine-readable name must contain only letters, numbers, dashes and underscores.');

    // Change the map alias value to a valid one.
    $alias_map['nothing'] = $this
      ->randomMachineName();
    $edit = [
      'row_options[field_options][name][alias]' => $alias_map['name'],
      'row_options[field_options][nothing][alias]' => $alias_map['nothing'],
    ];
    $this
      ->drupalGet($row_options);
    $this
      ->submitForm($edit, 'Apply');
    $this
      ->submitForm([], 'Save');
    $view = Views::getView('test_serializer_display_field');
    $view
      ->setDisplay('rest_export_1');
    $this
      ->executeView($view);
    $expected = [];
    foreach ($view->result as $row) {
      $expected_row = [];
      foreach ($view->field as $id => $field) {
        $expected_row[$alias_map[$id]] = $field
          ->render($row);
      }
      $expected[] = $expected_row;
    }
    $this
      ->assertEquals($expected, Json::decode($this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ])));
  }

  /**
   * Tests the raw output options for row field rendering.
   */
  public function testFieldRawOutput() {
    $this
      ->drupalLogin($this->adminUser);

    // Test the UI settings for adding field ID aliases.
    $this
      ->drupalGet('admin/structure/views/view/test_serializer_display_field/edit/rest_export_1');
    $row_options = 'admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/row_options';
    $this
      ->assertSession()
      ->linkByHrefExists($row_options);

    // Test an empty string for an alias, this should not be used. This also
    // tests that the form can be submitted with no aliases.
    $values = [
      'row_options[field_options][created][raw_output]' => '1',
      'row_options[field_options][name][raw_output]' => '1',
    ];
    $this
      ->drupalGet($row_options);
    $this
      ->submitForm($values, 'Apply');
    $this
      ->submitForm([], 'Save');
    $view = Views::getView('test_serializer_display_field');
    $view
      ->setDisplay('rest_export_1');
    $this
      ->executeView($view);
    $storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_test');

    // Update the name for each to include a script tag.
    foreach ($storage
      ->loadMultiple() as $entity_test) {
      $name = $entity_test->name->value;
      $entity_test
        ->set('name', "<script>{$name}</script>");
      $entity_test
        ->save();
    }

    // Just test the raw 'created' value against each row.
    foreach (Json::decode($this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ])) as $index => $values) {
      $this
        ->assertSame($view->result[$index]->views_test_data_created, $values['created'], 'Expected raw created value found.');
      $this
        ->assertSame($view->result[$index]->views_test_data_name, $values['name'], 'Expected raw name value found.');
    }

    // Test result with an excluded field.
    $view
      ->setDisplay('rest_export_1');
    $view->displayHandlers
      ->get('rest_export_1')
      ->overrideOption('fields', [
      'name' => [
        'id' => 'name',
        'table' => 'views_test_data',
        'field' => 'name',
        'relationship' => 'none',
      ],
      'created' => [
        'id' => 'created',
        'exclude' => TRUE,
        'table' => 'views_test_data',
        'field' => 'created',
        'relationship' => 'none',
      ],
    ]);
    $view
      ->save();
    $this
      ->executeView($view);
    foreach (Json::decode($this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ])) as $index => $values) {
      $this
        ->assertTrue(!isset($values['created']), 'Excluded value not found.');
    }

    // Test that the excluded field is not shown in the row options.
    $this
      ->drupalGet('admin/structure/views/nojs/display/test_serializer_display_field/rest_export_1/row_options');
    $this
      ->assertSession()
      ->pageTextNotContains('created');
  }

  /**
   * Tests the live preview output for json output.
   */
  public function testLivePreview() {

    // We set up a request so it looks like a request in the live preview.
    $request = new Request();
    $request->query
      ->add([
      MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax',
    ]);

    /** @var \Symfony\Component\HttpFoundation\RequestStack $request_stack */
    $request_stack = \Drupal::service('request_stack');
    $request_stack
      ->push($request);
    $view = Views::getView('test_serializer_display_entity');
    $view
      ->setDisplay('rest_export_1');
    $this
      ->executeView($view);

    // Get the serializer service.
    $serializer = $this->container
      ->get('serializer');
    $entities = [];
    foreach ($view->result as $row) {
      $entities[] = $row->_entity;
    }
    $expected = $serializer
      ->serialize($entities, 'json');
    $view->live_preview = TRUE;
    $build = $view
      ->preview();
    $rendered_json = $build['#plain_text'];
    $this
      ->assertArrayNotHasKey('#markup', $build);
    $this
      ->assertSame($expected, $rendered_json, 'Ensure the previewed json is escaped.');
    $view
      ->destroy();
    $expected = $serializer
      ->serialize($entities, 'xml');

    // Change the request format to xml.
    $view
      ->setDisplay('rest_export_1');
    $view
      ->getDisplay()
      ->setOption('style', [
      'type' => 'serializer',
      'options' => [
        'uses_fields' => FALSE,
        'formats' => [
          'xml' => 'xml',
        ],
      ],
    ]);
    $this
      ->executeView($view);
    $build = $view
      ->preview();
    $rendered_xml = $build['#plain_text'];
    $this
      ->assertEquals($expected, $rendered_xml, 'Ensure we preview xml when we change the request format.');
  }

  /**
   * Tests the views interface for REST export displays.
   */
  public function testSerializerViewsUI() {
    $this
      ->drupalLogin($this->adminUser);

    // Click the "Update preview button".
    $this
      ->drupalGet('admin/structure/views/view/test_serializer_display_field/edit/rest_export_1');
    $this
      ->submitForm($edit = [], 'Update preview');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Check if we receive the expected result.
    $result = $this
      ->assertSession()
      ->elementExists('xpath', '//div[@id="views-live-preview"]/pre');
    $json_preview = $result
      ->getText();
    $this
      ->assertSame($json_preview, $this
      ->drupalGet('test/serialize/field', [
      'query' => [
        '_format' => 'json',
      ],
    ]), 'The expected JSON preview output was found.');
  }

  /**
   * Tests the field row style using fieldapi fields.
   */
  public function testFieldapiField() {
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $node = $this
      ->drupalCreateNode();
    $result = Json::decode($this
      ->drupalGet('test/serialize/node-field', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $this
      ->assertEquals($node
      ->id(), $result[0]['nid']);
    $this
      ->assertEquals($node->body->processed, $result[0]['body']);

    // Make sure that serialized fields are not exposed to XSS.
    $node = $this
      ->drupalCreateNode();
    $node->body = [
      'value' => '<script type="text/javascript">alert("node-body");</script>' . $this
        ->randomMachineName(32),
      'format' => filter_default_format(),
    ];
    $node
      ->save();
    $result = Json::decode($this
      ->drupalGet('test/serialize/node-field', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $this
      ->assertEquals($node
      ->id(), $result[1]['nid']);
    $this
      ->assertStringNotContainsString("<script", $this
      ->getSession()
      ->getPage()
      ->getContent(), "No script tag is present in the raw page contents.");
    $this
      ->drupalLogin($this->adminUser);

    // Add an alias and make the output raw.
    $row_options = 'admin/structure/views/nojs/display/test_serializer_node_display_field/rest_export_1/row_options';

    // Test an empty string for an alias, this should not be used. This also
    // tests that the form can be submitted with no aliases.
    $this
      ->drupalGet($row_options);
    $this
      ->submitForm([
      'row_options[field_options][title][raw_output]' => '1',
    ], 'Apply');
    $this
      ->submitForm([], 'Save');
    $view = Views::getView('test_serializer_node_display_field');
    $view
      ->setDisplay('rest_export_1');
    $this
      ->executeView($view);

    // Test the raw 'created' value against each row.
    foreach (Json::decode($this
      ->drupalGet('test/serialize/node-field', [
      'query' => [
        '_format' => 'json',
      ],
    ])) as $index => $values) {
      $this
        ->assertSame($view->result[$index]->_entity->title->value, $values['title'], 'Expected raw title value found.');
    }

    // Test that multiple raw body fields are shown.
    // Set the body field to unlimited cardinality.
    $storage_definition = $node
      ->getFieldDefinition('body')
      ->getFieldStorageDefinition();
    $storage_definition
      ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
    $storage_definition
      ->save();
    $this
      ->drupalGet($row_options);
    $this
      ->submitForm([
      'row_options[field_options][body][raw_output]' => '1',
    ], 'Apply');
    $this
      ->submitForm([], 'Save');
    $node = $this
      ->drupalCreateNode();
    $body = [
      'value' => '<script type="text/javascript">alert("node-body");</script>' . $this
        ->randomMachineName(32),
      'format' => filter_default_format(),
    ];

    // Add two body items.
    $node->body = [
      $body,
      $body,
    ];
    $node
      ->save();
    $view = Views::getView('test_serializer_node_display_field');
    $view
      ->setDisplay('rest_export_1');
    $this
      ->executeView($view);
    $result = Json::decode($this
      ->drupalGet('test/serialize/node-field', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $this
      ->assertSame($node->body
      ->count(), count($result[2]['body']), 'Expected count of values');
    $this
      ->assertEquals($result[2]['body'], array_map(function ($item) {
      return $item['value'];
    }, $node->body
      ->getValue()), 'Expected raw body values found.');
  }

  /**
   * Tests the "Grouped rows" functionality.
   */
  public function testGroupRows() {
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);

    // Create a text field with cardinality set to unlimited.
    $field_name = 'field_group_rows';
    $field_storage = FieldStorageConfig::create([
      'field_name' => $field_name,
      'entity_type' => 'node',
      'type' => 'string',
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
    ]);
    $field_storage
      ->save();

    // Create an instance of the text field on the content type.
    $field = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'page',
    ]);
    $field
      ->save();
    $grouped_field_values = [
      'a',
      'b',
      'c',
    ];
    $edit = [
      'title' => $this
        ->randomMachineName(),
      $field_name => $grouped_field_values,
    ];
    $this
      ->drupalCreateNode($edit);
    $view = Views::getView('test_serializer_node_display_field');
    $view
      ->setDisplay('rest_export_1');

    // Override the view's fields to include the field_group_rows field, set the
    // group_rows setting to true.
    $fields = [
      $field_name => [
        'id' => $field_name,
        'table' => 'node__' . $field_name,
        'field' => $field_name,
        'type' => 'string',
        'group_rows' => TRUE,
      ],
    ];
    $view->displayHandlers
      ->get('default')
      ->overrideOption('fields', $fields);
    $build = $view
      ->preview();

    // Get the serializer service.
    $serializer = $this->container
      ->get('serializer');

    // Check if the field_group_rows field is grouped.
    $expected = [];
    $expected[] = [
      $field_name => implode(', ', $grouped_field_values),
    ];
    $this
      ->assertEquals($serializer
      ->serialize($expected, 'json'), (string) $this->renderer
      ->renderRoot($build));

    // Set the group rows setting to false.
    $view = Views::getView('test_serializer_node_display_field');
    $view
      ->setDisplay('rest_export_1');
    $fields[$field_name]['group_rows'] = FALSE;
    $view->displayHandlers
      ->get('default')
      ->overrideOption('fields', $fields);
    $build = $view
      ->preview();

    // Check if the field_group_rows field is ungrouped and displayed per row.
    $expected = [];
    foreach ($grouped_field_values as $grouped_field_value) {
      $expected[] = [
        $field_name => $grouped_field_value,
      ];
    }
    $this
      ->assertEquals($serializer
      ->serialize($expected, 'json'), (string) $this->renderer
      ->renderRoot($build));
  }

  /**
   * Tests the exposed filter works.
   *
   * There is an exposed filter on the title field which takes a title query
   * parameter. This is set to filter nodes by those whose title starts with
   * the value provided.
   */
  public function testRestViewExposedFilter() {
    $this
      ->drupalCreateContentType([
      'type' => 'page',
    ]);
    $node0 = $this
      ->drupalCreateNode([
      'title' => 'Node 1',
    ]);
    $node1 = $this
      ->drupalCreateNode([
      'title' => 'Node 11',
    ]);
    $node2 = $this
      ->drupalCreateNode([
      'title' => 'Node 111',
    ]);

    // Test that no filter brings back all three nodes.
    $result = Json::decode($this
      ->drupalGet('test/serialize/node-exposed-filter', [
      'query' => [
        '_format' => 'json',
      ],
    ]));
    $expected = [
      0 => [
        'nid' => $node0
          ->id(),
        'body' => $node0->body->processed,
      ],
      1 => [
        'nid' => $node1
          ->id(),
        'body' => $node1->body->processed,
      ],
      2 => [
        'nid' => $node2
          ->id(),
        'body' => $node2->body->processed,
      ],
    ];
    $this
      ->assertEquals($expected, $result, 'Querying a view with no exposed filter returns all nodes.');

    // Test that title starts with 'Node 11' query finds 2 of the 3 nodes.
    $result = Json::decode($this
      ->drupalGet('test/serialize/node-exposed-filter', [
      'query' => [
        '_format' => 'json',
        'title' => 'Node 11',
      ],
    ]));
    $expected = [
      0 => [
        'nid' => $node1
          ->id(),
        'body' => $node1->body->processed,
      ],
      1 => [
        'nid' => $node2
          ->id(),
        'body' => $node2->body->processed,
      ],
    ];
    $cache_contexts = [
      'languages:language_content',
      'languages:language_interface',
      'theme',
      'request_format',
      'user.node_grants:view',
      'url',
    ];
    $this
      ->assertEquals($expected, $result, 'Querying a view with a starts with exposed filter on the title returns nodes whose title starts with value provided.');
    $this
      ->assertCacheContexts($cache_contexts);
  }

  /**
   * Tests multilingual entity rows.
   */
  public function testMulEntityRows() {

    // Create some languages.
    ConfigurableLanguage::createFromLangcode('l1')
      ->save();
    ConfigurableLanguage::createFromLangcode('l2')
      ->save();

    // Create an entity with no translations.
    $storage = \Drupal::entityTypeManager()
      ->getStorage('entity_test_mul');
    $storage
      ->create([
      'langcode' => 'l1',
      'name' => 'mul-none',
    ])
      ->save();

    // Create some entities with translations.
    $entity = $storage
      ->create([
      'langcode' => 'l1',
      'name' => 'mul-l1-orig',
    ]);
    $entity
      ->save();
    $entity
      ->addTranslation('l2', [
      'name' => 'mul-l1-l2',
    ])
      ->save();
    $entity = $storage
      ->create([
      'langcode' => 'l2',
      'name' => 'mul-l2-orig',
    ]);
    $entity
      ->save();
    $entity
      ->addTranslation('l1', [
      'name' => 'mul-l2-l1',
    ])
      ->save();

    // Get the names of the output.
    $json = $this
      ->drupalGet('test/serialize/translated_entity', [
      'query' => [
        '_format' => 'json',
      ],
    ]);
    $decoded = $this->container
      ->get('serializer')
      ->decode($json, 'hal_json');
    $names = [];
    foreach ($decoded as $item) {
      $names[] = $item['name'][0]['value'];
    }
    sort($names);

    // Check that the names are correct.
    $expected = [
      'mul-l1-l2',
      'mul-l1-orig',
      'mul-l2-l1',
      'mul-l2-orig',
      'mul-none',
    ];
    $this
      ->assertSame($expected, $names, 'The translated content was found in the JSON.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
AssertPageCacheContextsAndTagsTrait::assertCacheContext	protected	function	Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts	protected	function	Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge	protected	function	Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags	protected	function	Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext	protected	function	Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags	protected	function	Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching	protected	function	Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues	protected	function	Gets a specific header value as array.
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
StyleSerializerTest::$adminUser	protected	property	A user with administrative privileges to look at test entity and configure views.
StyleSerializerTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
StyleSerializerTest::$modules	protected static	property	Modules to install. Overrides ViewTestBase::$modules
StyleSerializerTest::$renderer	protected	property	The renderer.
StyleSerializerTest::$testViews	public static	property	Views used by this test.
StyleSerializerTest::addRequestWithFormat	protected	function	Sets up a request on the request stack with a specified format.
StyleSerializerTest::setUp	protected	function	Overrides ViewTestBase::setUp
StyleSerializerTest::testFieldapiField	public	function	Tests the field row style using fieldapi fields.
StyleSerializerTest::testFieldRawOutput	public	function	Tests the raw output options for row field rendering.
StyleSerializerTest::testGroupRows	public	function	Tests the "Grouped rows" functionality.
StyleSerializerTest::testLivePreview	public	function	Tests the live preview output for json output.
StyleSerializerTest::testMulEntityRows	public	function	Tests multilingual entity rows.
StyleSerializerTest::testResponseFormatConfiguration	public	function	Tests the response format configuration.
StyleSerializerTest::testRestRenderCaching	public	function	Tests REST export with views render caching enabled.
StyleSerializerTest::testRestViewExposedFilter	public	function	Tests the exposed filter works.
StyleSerializerTest::testRestViewsAuthentication	public	function	Checks that the auth options restricts access to a REST views display.
StyleSerializerTest::testSerializerResponses	public	function	Checks the behavior of the Serializer callback paths and row plugins.
StyleSerializerTest::testSerializerViewsUI	public	function	Tests the views interface for REST export displays.
StyleSerializerTest::testSharedPagePath	public	function	Verifies REST export views work on the same path as a page display.
StyleSerializerTest::testSiteMaintenance	public	function	Verifies site maintenance mode functionality.
StyleSerializerTest::testUIFieldAlias	public	function	Tests the field ID alias functionality of the DataFieldRow plugin.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
ViewResultAssertionTrait::assertIdenticalResultset	protected	function	Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper	protected	function	Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset	protected	function	Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet	protected	function	Returns a very simple test dataset.	1
ViewTestBase::enableViewsTestModule	protected	function	Sets up the views_test_data.module.
ViewTestBase::executeView	protected	function	Executes a view.
ViewTestBase::helperButtonHasLabel	protected	function	Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet	protected	function	Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition	protected	function	Returns the schema definition.	1
ViewTestBase::viewsData	protected	function	Returns the views data definition.	8
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class StyleSerializerTest in Drupal 9

Hierarchy

See also

File

Namespace

Members

API Navigation