ModuleTest.php 14.7 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1 2
<?php

3
namespace Drupal\Tests\views\Kernel;
4

merlinofchaos's avatar
merlinofchaos committed
5 6
/**
 * Tests basic functions from the Views module.
7 8
 *
 * @group views
merlinofchaos's avatar
merlinofchaos committed
9
 */
10
use Drupal\views\Plugin\views\filter\Standard;
11
use Drupal\views\Views;
12
use Drupal\Component\Render\FormattableMarkup;
13

14
class ModuleTest extends ViewsKernelTestBase {
15

16 17 18 19 20
  /**
   * Views used by this test.
   *
   * @var array
   */
21
  public static $testViews = ['test_view_status', 'test_view', 'test_argument'];
22

23 24 25 26 27
  /**
   * Modules to enable.
   *
   * @var array
   */
28
  protected static $modules = ['field', 'user', 'block'];
29

30
  /**
31
   * Stores the last triggered error.
32 33 34 35 36 37 38
   *
   * @var string
   *
   * @see \Drupal\views\Tests\ModuleTest::errorHandler()
   */
  protected $lastErrorMessage;

merlinofchaos's avatar
merlinofchaos committed
39 40
  /**
   * Tests the views_get_handler method.
41 42
   *
   * @see views_get_handler()
merlinofchaos's avatar
merlinofchaos committed
43
   */
44
  public function testViewsGetHandler() {
45
    $types = ['field', 'area', 'filter'];
merlinofchaos's avatar
merlinofchaos committed
46
    foreach ($types as $type) {
47
      $item = [
48 49
        'table' => $this->randomMachineName(),
        'field' => $this->randomMachineName(),
50
      ];
51
      $handler = $this->container->get('plugin.manager.views.' . $type)->getHandler($item);
52
      $this->assertEqual('Drupal\views\Plugin\views\\' . $type . '\Broken', get_class($handler), new FormattableMarkup('Make sure that a broken handler of type: @type is created.', ['@type' => $type]));
merlinofchaos's avatar
merlinofchaos committed
53 54 55
    }

    $views_data = $this->viewsData();
56
    $test_tables = ['views_test_data' => ['id', 'name']];
merlinofchaos's avatar
merlinofchaos committed
57 58 59
    foreach ($test_tables as $table => $fields) {
      foreach ($fields as $field) {
        $data = $views_data[$table][$field];
60
        $item = [
61 62
          'table' => $table,
          'field' => $field,
63
        ];
merlinofchaos's avatar
merlinofchaos committed
64
        foreach ($data as $id => $field_data) {
65
          if (!in_array($id, ['title', 'help'])) {
66
            $handler = $this->container->get('plugin.manager.views.' . $id)->getHandler($item);
merlinofchaos's avatar
merlinofchaos committed
67 68 69 70 71 72
            $this->assertInstanceHandler($handler, $table, $field, $id);
          }
        }
      }
    }

73
    // Test the override handler feature.
74
    $item = [
75 76
      'table' => 'views_test_data',
      'field' => 'job',
77
    ];
78
    $handler = $this->container->get('plugin.manager.views.filter')->getHandler($item, 'standard');
79 80
    $this->assertTrue($handler instanceof Standard);

81 82 83 84
    // @todo Reinstate these tests when the debug() in views_get_handler() is
    //   restored.
    return;

85
    // Test non-existent tables/fields.
86 87
    set_error_handler([$this, 'customErrorHandler']);
    $item = [
88 89
      'table' => 'views_test_data',
      'field' => 'field_invalid',
90
    ];
91
    $this->container->get('plugin.manager.views.field')->getHandler($item);
92
    $this->assertTrue(strpos($this->lastErrorMessage, format_string("Missing handler: @table @field @type", ['@table' => 'views_test_data', '@field' => 'field_invalid', '@type' => 'field'])) !== FALSE, 'An invalid field name throws a debug message.');
93 94
    unset($this->lastErrorMessage);

95
    $item = [
96 97
      'table' => 'table_invalid',
      'field' => 'id',
98
    ];
99
    $this->container->get('plugin.manager.views.filter')->getHandler($item);
100
    $this->assertEqual(strpos($this->lastErrorMessage, format_string("Missing handler: @table @field @type", ['@table' => 'table_invalid', '@field' => 'id', '@type' => 'filter'])) !== FALSE, 'An invalid table name throws a debug message.');
101 102
    unset($this->lastErrorMessage);

103
    $item = [
104 105
      'table' => 'table_invalid',
      'field' => 'id',
106
    ];
107
    $this->container->get('plugin.manager.views.filter')->getHandler($item);
108
    $this->assertEqual(strpos($this->lastErrorMessage, format_string("Missing handler: @table @field @type", ['@table' => 'table_invalid', '@field' => 'id', '@type' => 'filter'])) !== FALSE, 'An invalid table name throws a debug message.');
109 110 111 112 113 114 115 116
    unset($this->lastErrorMessage);

    restore_error_handler();
  }

  /**
   * Defines an error handler which is used in the test.
   *
117 118
   * Because this is registered in set_error_handler(), it has to be public.
   *
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
   * @param int $error_level
   *   The level of the error raised.
   * @param string $message
   *   The error message.
   * @param string $filename
   *   The filename that the error was raised in.
   * @param int $line
   *   The line number the error was raised at.
   * @param array $context
   *   An array that points to the active symbol table at the point the error
   *   occurred.
   *
   * @see set_error_handler()
   */
  public function customErrorHandler($error_level, $message, $filename, $line, $context) {
    $this->lastErrorMessage = $message;
merlinofchaos's avatar
merlinofchaos committed
135 136
  }

137 138 139 140
  /**
   * Tests the load wrapper/helper functions.
   */
  public function testLoadFunctions() {
141 142
    $this->enableModules(['text', 'node']);
    $this->installConfig(['node']);
143
    $storage = $this->container->get('entity.manager')->getStorage('view');
144 145

    // Test views_view_is_enabled/disabled.
146
    $archive = $storage->load('archive');
147 148 149 150 151 152
    $this->assertTrue(views_view_is_disabled($archive), 'views_view_is_disabled works as expected.');
    // Enable the view and check this.
    $archive->enable();
    $this->assertTrue(views_view_is_enabled($archive), ' views_view_is_enabled works as expected.');

    // We can store this now, as we have enabled/disabled above.
153
    $all_views = $storage->loadMultiple();
154

155
    // Test Views::getAllViews().
156 157
    ksort($all_views);
    $this->assertEquals(array_keys($all_views), array_keys(Views::getAllViews()), 'Views::getAllViews works as expected.');
158

159
    // Test Views::getEnabledViews().
160
    $expected_enabled = array_filter($all_views, function ($view) {
161 162
      return views_view_is_enabled($view);
    });
163
    $this->assertEquals(array_keys($expected_enabled), array_keys(Views::getEnabledViews()), 'Expected enabled views returned.');
164

165
    // Test Views::getDisabledViews().
166
    $expected_disabled = array_filter($all_views, function ($view) {
167 168
      return views_view_is_disabled($view);
    });
169
    $this->assertEquals(array_keys($expected_disabled), array_keys(Views::getDisabledViews()), 'Expected disabled views returned.');
170

171
    // Test Views::getViewsAsOptions().
172
    // Test the $views_only parameter.
173
    $this->assertIdentical(array_keys($all_views), array_keys(Views::getViewsAsOptions(TRUE)), 'Expected option keys for all views were returned.');
174
    $expected_options = [];
175
    foreach ($all_views as $id => $view) {
176
      $expected_options[$id] = $view->label();
177
    }
178
    $this->assertIdentical($expected_options, $this->castSafeStrings(Views::getViewsAsOptions(TRUE)), 'Expected options array was returned.');
179 180

    // Test the default.
181
    $this->assertIdentical($this->formatViewOptions($all_views), $this->castSafeStrings(Views::getViewsAsOptions()), 'Expected options array for all views was returned.');
182
    // Test enabled views.
183
    $this->assertIdentical($this->formatViewOptions($expected_enabled), $this->castSafeStrings(Views::getViewsAsOptions(FALSE, 'enabled')), 'Expected enabled options array was returned.');
184
    // Test disabled views.
185
    $this->assertIdentical($this->formatViewOptions($expected_disabled), $this->castSafeStrings(Views::getViewsAsOptions(FALSE, 'disabled')), 'Expected disabled options array was returned.');
186 187 188 189

    // Test the sort parameter.
    $all_views_sorted = $all_views;
    ksort($all_views_sorted);
190
    $this->assertIdentical(array_keys($all_views_sorted), array_keys(Views::getViewsAsOptions(TRUE, 'all', NULL, FALSE, TRUE)), 'All view id keys returned in expected sort order');
191 192

    // Test $exclude_view parameter.
193 194 195
    $this->assertFalse(array_key_exists('archive', Views::getViewsAsOptions(TRUE, 'all', 'archive')), 'View excluded from options based on name');
    $this->assertFalse(array_key_exists('archive:default', Views::getViewsAsOptions(FALSE, 'all', 'archive:default')), 'View display excluded from options based on name');
    $this->assertFalse(array_key_exists('archive', Views::getViewsAsOptions(TRUE, 'all', $archive->getExecutable())), 'View excluded from options based on object');
196 197

    // Test the $opt_group parameter.
198
    $expected_opt_groups = [];
199 200
    foreach ($all_views as $view) {
      foreach ($view->get('display') as $display) {
201
        $expected_opt_groups[$view->id()][$view->id() . ':' . $display['id']] = (string) t('@view : @display', ['@view' => $view->id(), '@display' => $display['id']]);
202 203
      }
    }
204
    $this->assertIdentical($expected_opt_groups, $this->castSafeStrings(Views::getViewsAsOptions(FALSE, 'all', NULL, TRUE)), 'Expected option array for an option group returned.');
205 206 207 208 209
  }

  /**
   * Tests view enable and disable procedural wrapper functions.
   */
210
  public function testStatusFunctions() {
211
    $view = Views::getView('test_view_status')->storage;
212

213
    $this->assertFalse($view->status(), 'The view status is disabled.');
214 215

    views_enable_view($view);
216 217
    $this->assertTrue($view->status(), 'A view has been enabled.');
    $this->assertEqual($view->status(), views_view_is_enabled($view), 'views_view_is_enabled is correct.');
218 219

    views_disable_view($view);
220 221
    $this->assertFalse($view->status(), 'A view has been disabled.');
    $this->assertEqual(!$view->status(), views_view_is_disabled($view), 'views_view_is_disabled is correct.');
222 223
  }

224
  /**
225
   * Tests the \Drupal\views\Views::fetchPluginNames() method.
226 227 228
   */
  public function testViewsFetchPluginNames() {
    // All style plugins should be returned, as we have not specified a type.
229
    $plugins = Views::fetchPluginNames('style');
230
    $definitions = $this->container->get('plugin.manager.views.style')->getDefinitions();
231
    $expected = [];
232
    foreach ($definitions as $id => $definition) {
233 234 235 236 237 238 239
      $expected[$id] = $definition['title'];
    }
    asort($expected);
    $this->assertIdentical(array_keys($plugins), array_keys($expected));

    // Test using the 'test' style plugin type only returns the test_style and
    // mapping_test plugins.
240
    $plugins = Views::fetchPluginNames('style', 'test');
241
    $this->assertIdentical(array_keys($plugins), ['mapping_test', 'test_style', 'test_template_style']);
242 243

    // Test a non existent style plugin type returns no plugins.
244
    $plugins = Views::fetchPluginNames('style', $this->randomString());
245
    $this->assertIdentical($plugins, []);
246 247
  }

248
  /**
249
   * Tests the \Drupal\views\Views::pluginList() method.
250 251
   */
  public function testViewsPluginList() {
252
    $plugin_list = Views::pluginList();
253
    // Only plugins used by 'test_view' should be in the plugin list.
254
    foreach (['display:default', 'pager:none'] as $key) {
255 256 257
      list($plugin_type, $plugin_id) = explode(':', $key);
      $plugin_def = $this->container->get("plugin.manager.views.$plugin_type")->getDefinition($plugin_id);

258
      $this->assertTrue(isset($plugin_list[$key]), new FormattableMarkup('The expected @key plugin list key was found.', ['@key' => $key]));
259 260 261 262 263 264 265 266 267
      $plugin_details = $plugin_list[$key];

      $this->assertEqual($plugin_details['type'], $plugin_type, 'The expected plugin type was found.');
      $this->assertEqual($plugin_details['title'], $plugin_def['title'], 'The expected plugin title was found.');
      $this->assertEqual($plugin_details['provider'], $plugin_def['provider'], 'The expected plugin provider was found.');
      $this->assertTrue(in_array('test_view', $plugin_details['views']), 'The test_view View was found in the list of views using this plugin.');
    }
  }

268 269 270 271
  /**
   * Tests views.module: views_embed_view().
   */
  public function testViewsEmbedView() {
272 273 274
    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = \Drupal::service('renderer');

275
    $result = views_embed_view('test_argument');
276 277
    $renderer->renderPlain($result);
    $this->assertEqual(count($result['view_build']['#view']->result), 5);
278 279

    $result = views_embed_view('test_argument', 'default', 1);
280 281
    $renderer->renderPlain($result);
    $this->assertEqual(count($result['view_build']['#view']->result), 1);
282 283

    $result = views_embed_view('test_argument', 'default', '1,2');
284 285
    $renderer->renderPlain($result);
    $this->assertEqual(count($result['view_build']['#view']->result), 2);
286 287

    $result = views_embed_view('test_argument', 'default', '1,2', 'John');
288 289
    $renderer->renderPlain($result);
    $this->assertEqual(count($result['view_build']['#view']->result), 1);
290 291

    $result = views_embed_view('test_argument', 'default', '1,2', 'John,George');
292 293
    $renderer->renderPlain($result);
    $this->assertEqual(count($result['view_build']['#view']->result), 2);
294 295 296 297 298 299 300 301 302 303 304
  }

  /**
   * Tests the \Drupal\views\ViewsExecutable::preview() method.
   */
  public function testViewsPreview() {
    $view = Views::getView('test_argument');
    $result = $view->preview('default');
    $this->assertEqual(count($result['#view']->result), 5);

    $view = Views::getView('test_argument');
305
    $result = $view->preview('default', ['0' => 1]);
306 307 308
    $this->assertEqual(count($result['#view']->result), 1);

    $view = Views::getView('test_argument');
309
    $result = $view->preview('default', ['3' => 1]);
310 311 312
    $this->assertEqual(count($result['#view']->result), 1);

    $view = Views::getView('test_argument');
313
    $result = $view->preview('default', ['0' => '1,2']);
314 315 316
    $this->assertEqual(count($result['#view']->result), 2);

    $view = Views::getView('test_argument');
317
    $result = $view->preview('default', ['3' => '1,2']);
318 319 320
    $this->assertEqual(count($result['#view']->result), 2);

    $view = Views::getView('test_argument');
321
    $result = $view->preview('default', ['0' => '1,2', '1' => 'John']);
322 323 324
    $this->assertEqual(count($result['#view']->result), 1);

    $view = Views::getView('test_argument');
325
    $result = $view->preview('default', ['3' => '1,2', '4' => 'John']);
326 327 328
    $this->assertEqual(count($result['#view']->result), 1);

    $view = Views::getView('test_argument');
329
    $result = $view->preview('default', ['0' => '1,2', '1' => 'John,George']);
330 331 332
    $this->assertEqual(count($result['#view']->result), 2);

    $view = Views::getView('test_argument');
333
    $result = $view->preview('default', ['3' => '1,2', '4' => 'John,George']);
334 335 336
    $this->assertEqual(count($result['#view']->result), 2);
  }

337 338 339 340
  /**
   * Helper to return an expected views option array.
   *
   * @param array $views
341
   *   An array of Drupal\views\Entity\View objects for which to
342
   *   create an options array.
343 344 345 346
   *
   * @return array
   *   A formatted options array that matches the expected output.
   */
347 348
  protected function formatViewOptions(array $views = []) {
    $expected_options = [];
349 350
    foreach ($views as $view) {
      foreach ($view->get('display') as $display) {
351
        $expected_options[$view->id() . ':' . $display['id']] = (string) t('View: @view - Display: @display',
352
          ['@view' => $view->id(), '@display' => $display['id']]);
353 354 355 356 357 358
      }
    }

    return $expected_options;
  }

merlinofchaos's avatar
merlinofchaos committed
359 360 361
  /**
   * Ensure that a certain handler is a instance of a certain table/field.
   */
362
  public function assertInstanceHandler($handler, $table, $field, $id) {
363
    $table_data = $this->container->get('views.views_data')->get($table);
merlinofchaos's avatar
merlinofchaos committed
364 365
    $field_data = $table_data[$field][$id];

aspilicious's avatar
aspilicious committed
366
    $this->assertEqual($field_data['id'], $handler->getPluginId());
merlinofchaos's avatar
merlinofchaos committed
367
  }
368

merlinofchaos's avatar
merlinofchaos committed
369
}