Code development platform for open source projects from the European Union institutions

Skip to content
Snippets Groups Projects
Commit 760db5ad authored by drishu's avatar drishu
Browse files

OEL-450: Kernel block rendering test.

parent 21f18a3b
No related branches found
No related tags found
1 merge request!3OEL-450: Theme the site branding block.
Hide whitespace changes
Inline Side-by-side
tests/Functional/SiteBrandingBlockTest.php deleted 100644 → 0
+ 0
− 68
View file @ 21f18a3b
<?php
declare(strict_types = 1);
namespace Drupal\Tests\oe_whitelabel\Functional;
use Drupal\Tests\BrowserTestBase;
/**
* Tests of Site Branding Block.
*/
class SiteBrandingBlockTest extends BrowserTestBase {
/**
* {@inheritdoc}
*/
public static $modules = [
'config',
'system',
'ui_patterns',
'ui_patterns_library',
'ui_patterns_settings',
'components',
'field',
'field_ui',
'toolbar',
'block',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
// Enable and set OpenEuropa Whitelabel Theme as default.
\Drupal::service('theme_installer')->install(['oe_whitelabel']);
\Drupal::configFactory()
->getEditable('system.theme')
->set('default', 'oe_whitelabel')
->save();
/* Rebuild the ui_pattern definitions to collect the ones provided by
oe_whitelabel itself. */
\Drupal::service('plugin.manager.ui_patterns')->clearCachedDefinitions();
// Ensure that the system branding block is placed as well.
$this->drupalPlaceBlock('system_branding_block', [
'region' => 'header',
]);
}
/**
* Asserts classes contained at site branding block.
*/
public function testClassesSiteName(): void {
$this->drupalGet('<front>');
$assert_session = $this->assertSession();
$assert_session->elementExists('css', 'div.site-name.h1.text-white.text-decoration-none.align-bottom');
}
}
tests/src/Kernel/RenderingTest.php deleted 100644 → 0
+ 0
− 167
View file @ 21f18a3b
<?php
declare(strict_types = 1);
namespace Drupal\Tests\oe_whitelabel\Kernel;
use Drupal\Core\Form\FormInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Tests\token\Kernel\KernelTestBase;
use Symfony\Component\DomCrawler\Crawler;
use Symfony\Component\Yaml\Yaml;
/**
* Tests that rendering of elements follows the theme implementation.
*/
class RenderingTest extends KernelTestBase implements FormInterface {
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'oe_whitelabel_rendering_test_form';
}
/**
* Form constructor.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $structure
* The structure of the form, read from the fixtures files.
*
* @return array
* The form structure.
*/
public function buildForm(array $form, FormStateInterface $form_state, array $structure = NULL): array {
$form['test'] = $structure;
return $form;
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {}
/**
* Test rendering of elements.
*
* @param array $structure
* A render array.
* @param array $assertions
* Test assertions.
*
* @throws \Exception
*
* @dataProvider renderingDataProvider
*/
public function testRendering(array $structure, array $assertions): void {
// Wrap all the test structure inside a form. This will allow proper
// processing of form elements and invocation of form alter hooks.
// Even if the elements being tested are not form related, the form can
// host them without causing any issues.
$form_state = new FormState();
$form_state->addBuildInfo('args', [$structure]);
$form_state->setProgrammed();
$form = $this->container->get('form_builder')->buildForm($this, $form_state);
$this->assertRendering($this->renderRoot($form), $assertions);
}
/**
* Data provider for rendering tests.
*
* The actual data is read from fixtures stored in a YAML configuration.
*
* @return array
* A set of dump data for testing.
*/
public function renderingDataProvider(): array {
return $this->getFixtureContent('rendering.yml');
}
/**
* Run various assertion on given HTML string via CSS selectors.
*
* Specifically:
*
* - 'count': assert how many times the given HTML elements occur.
* - 'equals': assert content of given HTML elements.
* - 'contains': assert content contained in given HTML elements.
*
* Assertions array has to be provided in the following format:
*
* [
* 'count' => [
* '.ecl-page-header' => 1,
* ],
* 'equals' => [
* '.ecl-page-header__identity' => 'Digital single market',
* ],
* 'contains' => [
* 'Digital',
* 'single',
* 'market',
* ],
* ]
*
* @param string $html
* A render array.
* @param array $assertions
* Test assertions.
*/
protected function assertRendering(string $html, array $assertions): void {
$crawler = new Crawler($html);
// Assert presence of given strings.
if (isset($assertions['contains'])) {
foreach ($assertions['contains'] as $string) {
$message = "String '{$string}' not found in:" . PHP_EOL . $html;
$this->assertContains($string, $html, $message);
}
}
// Assert occurrences of given elements.
if (isset($assertions['count'])) {
foreach ($assertions['count'] as $name => $expected) {
$message = "Wrong number of occurrences found for element '{$name}' in:" . PHP_EOL . $html;
$this->assertCount($expected, $crawler->filter($name), $message);
}
}
// Assert that a given element content equals a given string.
if (isset($assertions['equals'])) {
foreach ($assertions['equals'] as $name => $expected) {
try {
$actual = trim($crawler->filter($name)->html());
}
catch (\InvalidArgumentException $exception) {
$this->fail(sprintf('Element "%s" not found (exception: "%s") in: ' . PHP_EOL . ' %s', $name, $exception->getMessage(), $html));
}
$this->assertEquals($expected, $actual);
}
}
}
/**
* Get fixture content.
*
* @param string $filepath
* File path.
*
* @return array
* A set of test data.
*/
protected function getFixtureContent(string $filepath): array {
return Yaml::parse(file_get_contents(__DIR__ . "/fixtures/{$filepath}"));
}
}
tests/src/Kernel/SiteBrandingBlockTest.php 0 → 100644
+ 74
− 0
View file @ 760db5ad
<?php
declare(strict_types = 1);
namespace Drupal\Tests\oe_whitelabel\Kernel;
use Drupal\Tests\token\Kernel\KernelTestBase;
use Symfony\Component\DomCrawler\Crawler;
/**
* Tests the Site Branding Block rendering.
*/
class SiteBrandingBlockTest extends KernelTestBase {
/**
* {@inheritdoc}
*/
public static $modules = ['block', 'system'];
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->container->get('theme_installer')->install(['oe_whitelabel']);
$this->container->get('theme_handler')->setDefault('oe_whitelabel');
$this->container->set('theme.registry', NULL);
$this->config('system.site')
->set('name', 'Site name')
->set('slogan', 'Slogan')
->save();
$this->container->get('cache.render')->deleteAll();
}
/**
* Tests the rendering of blocks.
*/
public function testBlockRendering(): void {
$entity_type_manager = $this->container
->get('entity_type.manager')
->getStorage('block');
$entity = $entity_type_manager->create([
'id' => 'test_block',
'theme' => 'oe_whitelabel',
'plugin' => 'system_branding_block',
'settings' => [
'id' => 'system_branding_block',
'label' => 'Site branding',
'provider' => 'system',
'label_display' => '0',
'use_site_logo' => TRUE,
'use_site_name' => TRUE,
'use_site_slogan' => FALSE,
],
]);
$entity->save();
$builder = \Drupal::entityTypeManager()->getViewBuilder('block');
$build = $builder->view($entity, 'block');
$render = $this->container->get('renderer')->renderRoot($build);
$crawler = new Crawler($render->__toString());
$actual = $crawler->filter('.site-name.h1.text-white.text-decoration-none.align-bottom');
$this->assertCount(1, $actual);
$actual = $crawler->filter('.site-logo');
$this->assertCount(1, $actual);
$logo = $actual->filter('img');
$this->assertCount(1, $logo);
$expected = '/' . drupal_get_path('theme', 'oe_whitelabel') . '/logo.svg';
$this->assertSame($expected, $logo->attr('src'));
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

For further information about the platform and support, please see https://code.europa.eu/info/about