ThemeTest.php 11.9 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Definition of Drupal\system\Tests\Theme\ThemeTest.
 */

namespace Drupal\system\Tests\Theme;

10
use Drupal\Component\Serialization\Json;
11
use Drupal\simpletest\WebTestBase;
12
use Drupal\test_theme\ThemeClass;
13 14 15
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;
16 17 18

/**
 * Tests low-level theme functions.
19 20
 *
 * @group Theme
21 22
 */
class ThemeTest extends WebTestBase {
23 24 25 26 27 28

  /**
   * Modules to enable.
   *
   * @var array
   */
29
  public static $modules = array('theme_test', 'node');
30

31
  protected function setUp() {
32
    parent::setUp();
33
    \Drupal::service('theme_handler')->install(array('test_theme'));
34 35
  }

36 37 38 39
  /**
   * Test attribute merging.
   *
   * Render arrays that use a render element and templates (and hence call
40
   * template_preprocess()) must ensure the attributes at different occasions
41
   * are all merged correctly:
42
   *   - $variables['attributes'] as passed in to _theme()
43 44 45 46
   *   - the render element's #attributes
   *   - any attributes set in the template's preprocessing function
   */
  function testAttributeMerging() {
47
    $theme_test_render_element = array(
48 49 50 51 52 53
      'elements' => array(
        '#attributes' => array('data-foo' => 'bar'),
      ),
      'attributes' => array(
        'id' => 'bazinga',
      ),
54 55
    );
    $this->assertThemeOutput('theme_test_render_element', $theme_test_render_element, '<div id="bazinga" data-foo="bar" data-variables-are-preprocessed></div>' . "\n");
56 57
  }

58
  /**
59
   * Test that _theme() returns expected data types.
60 61
   */
  function testThemeDataTypes() {
62 63
    // theme_test_false is an implemented theme hook so \Drupal::theme() service should
    // return a string, even though the theme function itself can return anything.
64 65
    $foos = array('null' => NULL, 'false' => FALSE, 'integer' => 1, 'string' => 'foo');
    foreach ($foos as $type => $example) {
66 67
      $output = \Drupal::theme()->render('theme_test_foo', array('foo' => $example));
      $this->assertTrue(is_string($output), format_string('\Drupal::theme() returns a string for data type !type.', array('!type' => $type)));
68 69
    }

70
    // suggestionnotimplemented is not an implemented theme hook so \Drupal::theme() service
71
    // should return FALSE instead of a string.
72 73
    $output = \Drupal::theme()->render(array('suggestionnotimplemented'), array());
    $this->assertIdentical($output, FALSE, '\Drupal::theme() returns FALSE when a hook suggestion is not implemented.');
74 75
  }

76 77 78 79 80 81
  /**
   * 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.
82
    $this->config('system.site')->set('page.front', 'nobody-home')->save();
83 84
    $args = array('node', '1', 'edit');
    $suggestions = theme_get_suggestions($args, 'page');
85
    $this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1', 'page__node__edit'), 'Found expected node edit page suggestions');
86 87 88
    // Check attack vectors.
    $args = array('node', '\\1');
    $suggestions = theme_get_suggestions($args, 'page');
89
    $this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1'), 'Removed invalid \\ from suggestions');
90 91
    $args = array('node', '1/');
    $suggestions = theme_get_suggestions($args, 'page');
92
    $this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1'), 'Removed invalid / from suggestions');
93 94
    $args = array('node', "1\0");
    $suggestions = theme_get_suggestions($args, 'page');
95
    $this->assertEqual($suggestions, array('page__node', 'page__node__%', 'page__node__1'), 'Removed invalid \\0 from suggestions');
96 97 98 99
    // 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');
100
    $this->assertEqual($suggestions, $result, 'Found expected page suggestions for paths containing hyphens.');
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
  }

  /**
   * 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.');
    }
  }

119 120 121 122 123 124 125 126 127 128 129
  /**
   * 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.');
  }

130 131 132 133 134 135 136 137 138
  /**
   * 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']);
  }

139 140 141 142
  /**
   * Ensure page-front template suggestion is added when on front page.
   */
  function testFrontPageThemeSuggestion() {
143 144 145 146 147 148
    // 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);
149
    $this->config('system.site')->set('page.front', 'user/login')->save();
150
    $suggestions = theme_get_suggestions(array('user', 'login'), 'page');
151
    // Set it back to not annoy the batch runner.
152
    \Drupal::requestStack()->pop();
153
    $this->assertTrue(in_array('page__front', $suggestions), 'Front page template was suggested.');
154 155 156
  }

  /**
157
   * Ensures a theme's .info.yml file is able to override a module CSS file from being added to the page.
158
   *
159
   * @see test_theme.info.yml
160 161 162
   */
  function testCSSOverride() {
    // Reuse the same page as in testPreprocessForSuggestions(). We're testing
163 164 165
    // 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.
166
    $config = $this->config('system.performance');
167
    $config->set('css.preprocess', 0);
168 169
    $config->save();
    $this->drupalGet('theme-test/suggestion');
170
    $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.');
171 172 173 174 175

    // 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.
176
    $config->set('css.preprocess', 1);
177 178
    $config->save();
    $this->drupalGet('theme-test/suggestion');
179
    $config->set('css.preprocess', 0);
180 181 182 183 184 185 186
    $config->save();
  }

  /**
   * Ensures a themes template is overrideable based on the 'template' filename.
   */
  function testTemplateOverride() {
187
    $this->config('system.theme')
188 189
      ->set('default', 'test_theme')
      ->save();
190
    $this->drupalGet('theme-test/template-test');
191
    $this->assertText('Success: Template overridden.', 'Template overridden by defined \'template\' filename.');
192 193
  }

194 195 196 197 198 199 200 201
  /**
   * 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.');
  }

202
  /**
203
   * Test the listInfo() function.
204 205
   */
  function testListThemes() {
206
    $theme_handler = $this->container->get('theme_handler');
207
    $theme_handler->install(array('test_subtheme'));
208 209
    $themes = $theme_handler->listInfo();

210 211
    // Check if ThemeHandlerInterface::listInfo() retrieves enabled themes.
    $this->assertIdentical(1, $themes['test_theme']->status, 'Installed theme detected');
212

213
    // Check if ThemeHandlerInterface::listInfo() returns disabled themes.
214 215
    // Check for base theme and subtheme lists.
    $base_theme_list = array('test_basetheme' => 'Theme test base theme');
216 217
    $sub_theme_list = array('test_subsubtheme' => 'Theme test subsubtheme', 'test_subtheme' => 'Theme test subtheme');

218 219
    $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.');
220
    // Check for theme engine in subtheme.
221
    $this->assertIdentical($themes['test_subtheme']->engine, 'twig', 'Subtheme\'s object includes the theme engine.');
222
    // Check for theme engine prefix.
223 224
    $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.');
225 226
  }

227 228 229 230 231 232 233 234 235 236
  /**
   * Tests child element rendering for 'render element' theme hooks.
   */
  function testDrupalRenderChildren() {
    $element = array(
      '#theme' => 'theme_test_render_element_children',
      'child' => array(
        '#markup' => 'Foo',
      ),
    );
237
    $this->assertThemeOutput('theme_test_render_element_children', $element, 'Foo', 'drupal_render() avoids #theme recursion loop when rendering a render element.');
238 239 240 241 242 243 244

    $element = array(
      '#theme_wrappers' => array('theme_test_render_element_children'),
      'child' => array(
        '#markup' => 'Foo',
      ),
    );
245
    $this->assertThemeOutput('theme_test_render_element_children', $element, 'Foo', 'drupal_render() avoids #theme_wrappers recursion loop when rendering a render element.');
246 247
  }

248 249 250 251 252 253
  /**
   * Tests theme can provide classes.
   */
  function testClassLoading() {
    new ThemeClass();
  }
254 255 256 257 258

  /**
   * Tests drupal_find_theme_templates().
   */
  public function testFindThemeTemplates() {
259 260 261
    $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.');
262
  }
263 264 265 266 267 268 269 270 271 272 273

  /**
   * 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).');
274
    $this->assertText('theme test page bottom markup', 'Modules are able to set the page bottom region.');
275 276
  }

277 278 279 280
  /**
   * Tests that region attributes can be manipulated via preprocess functions.
   */
  function testRegionClass() {
281
    \Drupal::service('module_installer')->install(array('block', 'theme_region_test'));
282 283 284 285 286 287 288 289

    // 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.');
  }

290
}