Newer
Older
catch
committed
<?php
/**
* @file
* Contains \Drupal\system\Tests\Theme\ThemeTest.
catch
committed
*/
namespace Drupal\system\Tests\Theme;
use Drupal\Component\Serialization\Json;
catch
committed
use Drupal\simpletest\WebTestBase;
Angie Byron
committed
use Drupal\test_theme\ThemeClass;
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;
Alex Bronstein
committed
use Drupal\Component\Render\MarkupInterface;
catch
committed
/**
* Tests low-level theme functions.
*
* @group Theme
catch
committed
*/
class ThemeTest extends WebTestBase {
/**
* Modules to enable.
*
* @var array
*/
Alex Pott
committed
public static $modules = array('theme_test', 'node');
Alex Pott
committed
protected function setUp() {
parent::setUp();
catch
committed
\Drupal::service('theme_handler')->install(array('test_theme'));
catch
committed
}
/**
* Test attribute merging.
*
* Render arrays that use a render element and templates (and hence call
Jennifer Hodgdon
committed
* template_preprocess()) must ensure the attributes at different occasions
* are all merged correctly:
* - $variables['attributes'] as passed in to _theme()
* - the render element's #attributes
* - any attributes set in the template's preprocessing function
*/
function testAttributeMerging() {
Alex Pott
committed
$theme_test_render_element = array(
'elements' => array(
'#attributes' => array('data-foo' => 'bar'),
),
'attributes' => array(
'id' => 'bazinga',
),
Alex Pott
committed
);
$this->assertThemeOutput('theme_test_render_element', $theme_test_render_element, '<div id="bazinga" data-foo="bar" data-variables-are-preprocessed></div>' . "\n");
}
Alex Pott
committed
/**
* Test that _theme() returns expected data types.
Alex Pott
committed
*/
function testThemeDataTypes() {
// theme_test_false is an implemented theme hook so \Drupal::theme() service
Alex Bronstein
committed
// should return a string or an object that implements MarkupInterface,
// even though the theme function itself can return anything.
$foos = array('null' => NULL, 'false' => FALSE, 'integer' => 1, 'string' => 'foo', 'empty_string' => '');
Alex Pott
committed
foreach ($foos as $type => $example) {
Alex Pott
committed
$output = \Drupal::theme()->render('theme_test_foo', array('foo' => $example));
Alex Bronstein
committed
$this->assertTrue($output instanceof MarkupInterface || is_string($output), format_string('\Drupal::theme() returns an object that implements MarkupInterface or a string for data type @type.', array('@type' => $type)));
if ($output instanceof MarkupInterface) {
$this->assertIdentical((string) $example, $output->__toString());
}
elseif (is_string($output)) {
$this->assertIdentical($output, '', 'A string will be return when the theme returns an empty string.');
}
Alex Pott
committed
}
Alex Pott
committed
// suggestionnotimplemented is not an implemented theme hook so \Drupal::theme() service
Alex Pott
committed
// should return FALSE instead of a string.
Alex Pott
committed
$output = \Drupal::theme()->render(array('suggestionnotimplemented'), array());
$this->assertIdentical($output, FALSE, '\Drupal::theme() returns FALSE when a hook suggestion is not implemented.');
Alex Pott
committed
}
catch
committed
/**
* Test function theme_get_suggestions() for SA-CORE-2009-003.
*/
function testThemeSuggestions() {
// Set the front page as something random otherwise the CLI
// test runner fails.
$this->config('system.site')->set('page.front', '/nobody-home')->save();
catch
committed
$args = array('node', '1', 'edit');
$suggestions = theme_get_suggestions($args, 'page');
$this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1', 'page__node__edit'), 'Found expected node edit page suggestions');
catch
committed
// Check attack vectors.
$args = array('node', '\\1');
$suggestions = theme_get_suggestions($args, 'page');
$this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1'), 'Removed invalid \\ from suggestions');
catch
committed
$args = array('node', '1/');
$suggestions = theme_get_suggestions($args, 'page');
$this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1'), 'Removed invalid / from suggestions');
catch
committed
$args = array('node', "1\0");
$suggestions = theme_get_suggestions($args, 'page');
$this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1'), 'Removed invalid \\0 from suggestions');
catch
committed
// Define path with hyphens to be used to generate suggestions.
$args = array('node', '1', 'hyphen-path');
$result = array('page__node', 'page__node__%', 'page__node__1', 'page__node__hyphen_path');
$suggestions = theme_get_suggestions($args, 'page');
$this->assertEqual($suggestions, $result, 'Found expected page suggestions for paths containing hyphens.');
catch
committed
}
/**
* Ensures preprocess functions run even for suggestion implementations.
*
* The theme hook used by this test has its base preprocess function in a
* separate file, so this test also ensures that that file is correctly loaded
* when needed.
*/
function testPreprocessForSuggestions() {
// Test with both an unprimed and primed theme registry.
drupal_theme_rebuild();
for ($i = 0; $i < 2; $i++) {
$this->drupalGet('theme-test/suggestion');
$this->assertText('Theme hook implementor=test_theme_theme_test__suggestion(). Foo=template_preprocess_theme_test', 'Theme hook suggestion ran with data available from a preprocess function for the base hook.');
}
}
/**
* Tests the priority of some theme negotiators.
*/
public function testNegotiatorPriorities() {
$this->drupalGet('theme-test/priority');
// Ensure that the custom theme negotiator was not able to set the theme.
$this->assertNoText('Theme hook implementor=test_theme_theme_test__suggestion(). Foo=template_preprocess_theme_test', 'Theme hook suggestion ran with data available from a preprocess function for the base hook.');
}
/**
* Ensures that non-HTML requests never initialize themes.
*/
public function testThemeOnNonHtmlRequest() {
$this->drupalGet('theme-test/non-html');
$json = Json::decode($this->getRawContent());
$this->assertFalse($json['theme_initialized']);
}
catch
committed
/**
* Ensure page-front template suggestion is added when on front page.
*/
function testFrontPageThemeSuggestion() {
// Set the current route to user.login because theme_get_suggestions() will
// query it to see if we are on the front page.
$request = Request::create('/user/login');
$request->attributes->set(RouteObjectInterface::ROUTE_NAME, 'user.login');
$request->attributes->set(RouteObjectInterface::ROUTE_OBJECT, new Route('/user/login'));
\Drupal::requestStack()->push($request);
$this->config('system.site')->set('page.front', '/user/login')->save();
$suggestions = theme_get_suggestions(array('user', 'login'), 'page');
catch
committed
// Set it back to not annoy the batch runner.
\Drupal::requestStack()->pop();
$this->assertTrue(in_array('page__front', $suggestions), 'Front page template was suggested.');
catch
committed
}
/**
* Ensures a theme's .info.yml file is able to override a module CSS file from being added to the page.
catch
committed
*
* @see test_theme.info.yml
catch
committed
*/
function testCSSOverride() {
// Reuse the same page as in testPreprocessForSuggestions(). We're testing
// what is output to the HTML HEAD based on what is in a theme's .info.yml
// file, so it doesn't matter what page we get, as long as it is themed with
// the test theme. First we test with CSS aggregation disabled.
$config = $this->config('system.performance');
$config->set('css.preprocess', 0);
catch
committed
$config->save();
$this->drupalGet('theme-test/suggestion');
Alex Pott
committed
$this->assertNoText('system.module.css', 'The theme\'s .info.yml file is able to override a module CSS file from being added to the page.');
catch
committed
// Also test with aggregation enabled, simply ensuring no PHP errors are
// triggered during drupal_build_css_cache() when a source file doesn't
// exist. Then allow remaining tests to continue with aggregation disabled
// by default.
$config->set('css.preprocess', 1);
catch
committed
$config->save();
$this->drupalGet('theme-test/suggestion');
$config->set('css.preprocess', 0);
catch
committed
$config->save();
}
/**
Alex Pott
committed
* Ensures a themes template is overridable based on the 'template' filename.
catch
committed
*/
function testTemplateOverride() {
$this->config('system.theme')
->set('default', 'test_theme')
->save();
catch
committed
$this->drupalGet('theme-test/template-test');
$this->assertText('Success: Template overridden.', 'Template overridden by defined \'template\' filename.');
catch
committed
}
Alex Pott
committed
/**
* Ensures a theme template can override a theme function.
*/
function testFunctionOverride() {
$this->drupalGet('theme-test/function-template-overridden');
$this->assertText('Success: Template overrides theme function.', 'Theme function overridden by test_theme template.');
}
catch
committed
/**
* Test the listInfo() function.
catch
committed
*/
function testListThemes() {
$theme_handler = $this->container->get('theme_handler');
catch
committed
$theme_handler->install(array('test_subtheme'));
$themes = $theme_handler->listInfo();
catch
committed
// Check if ThemeHandlerInterface::listInfo() retrieves enabled themes.
$this->assertIdentical(1, $themes['test_theme']->status, 'Installed theme detected');
// Check if ThemeHandlerInterface::listInfo() returns disabled themes.
catch
committed
// Check for base theme and subtheme lists.
$base_theme_list = array('test_basetheme' => 'Theme test base theme');
$sub_theme_list = array('test_subsubtheme' => 'Theme test subsubtheme', 'test_subtheme' => 'Theme test subtheme');
$this->assertIdentical($themes['test_basetheme']->sub_themes, $sub_theme_list, 'Base theme\'s object includes list of subthemes.');
$this->assertIdentical($themes['test_subtheme']->base_themes, $base_theme_list, 'Subtheme\'s object includes list of base themes.');
catch
committed
// Check for theme engine in subtheme.
$this->assertIdentical($themes['test_subtheme']->engine, 'twig', 'Subtheme\'s object includes the theme engine.');
catch
committed
// Check for theme engine prefix.
$this->assertIdentical($themes['test_basetheme']->prefix, 'twig', 'Base theme\'s object includes the theme engine prefix.');
$this->assertIdentical($themes['test_subtheme']->prefix, 'twig', 'Subtheme\'s object includes the theme engine prefix.');
catch
committed
}
/**
* Tests child element rendering for 'render element' theme hooks.
*/
function testDrupalRenderChildren() {
$element = array(
'#theme' => 'theme_test_render_element_children',
'child' => array(
'#markup' => 'Foo',
),
);
Alex Pott
committed
$this->assertThemeOutput('theme_test_render_element_children', $element, 'Foo', 'drupal_render() avoids #theme recursion loop when rendering a render element.');
$element = array(
'#theme_wrappers' => array('theme_test_render_element_children'),
'child' => array(
'#markup' => 'Foo',
),
);
Alex Pott
committed
$this->assertThemeOutput('theme_test_render_element_children', $element, 'Foo', 'drupal_render() avoids #theme_wrappers recursion loop when rendering a render element.');
}
Angie Byron
committed
/**
* Tests theme can provide classes.
*/
function testClassLoading() {
new ThemeClass();
}
Dries Buytaert
committed
/**
* Tests drupal_find_theme_templates().
*/
public function testFindThemeTemplates() {
$registry = $this->container->get('theme.registry')->get();
$templates = drupal_find_theme_templates($registry, '.html.twig', drupal_get_path('theme', 'test_theme'));
$this->assertEqual($templates['node__1']['template'], 'node--1', 'Template node--1.tpl.twig was found in test_theme.');
Dries Buytaert
committed
}
/**
* Tests that the page variable is not prematurely flattened.
*
* Some modules check the page array in template_preprocess_html(), so we
* ensure that it has not been rendered prematurely.
*/
function testPreprocessHtml() {
$this->drupalGet('');
$attributes = $this->xpath('/html/body[@theme_test_page_variable="Page variable is an array."]');
$this->assertTrue(count($attributes) == 1, 'In template_preprocess_html(), the page variable is still an array (not rendered yet).');
$this->assertText('theme test page bottom markup', 'Modules are able to set the page bottom region.');
}
/**
* Tests that region attributes can be manipulated via preprocess functions.
*/
public function testRegionClass() {
Alex Pott
committed
\Drupal::service('module_installer')->install(array('block', 'theme_region_test'));
// Place a block.
$this->drupalPlaceBlock('system_main_block');
$this->drupalGet('');
$elements = $this->cssSelect(".region-sidebar-first.new_class");
$this->assertEqual(count($elements), 1, 'New class found.');
}
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
/**
* Ensures suggestion preprocess functions run for default implementations.
*
* The theme hook used by this test has its base preprocess function in a
* separate file, so this test also ensures that that file is correctly loaded
* when needed.
*/
public function testSuggestionPreprocessForDefaults() {
\Drupal::service('theme_handler')->setDefault('test_theme');
// Test with both an unprimed and primed theme registry.
drupal_theme_rebuild();
for ($i = 0; $i < 2; $i++) {
$this->drupalGet('theme-test/preprocess-suggestions');
$items = $this->cssSelect('.suggestion');
$expected_values = [
'Suggestion',
'Kitten',
'Monkey',
'Kitten',
'Flamingo',
];
foreach ($expected_values as $key => $value) {
$this->assertEqual((string) $value, $items[$key]);
}
}
}