Commit d0244b4f authored by webchick's avatar webchick
Browse files

Issue #2121855 by dawehner, tim.plunkett, damiankloip: Move the views data tests to a unit test.

parent 6558a769
<?php
/**
* @file
* Definition of Drupal\views\Tests\ViewsDataTest.
*/
namespace Drupal\views\Tests;
use Drupal\Core\Cache\MemoryCounterBackend;
use Drupal\Core\Language\LanguageManager;
use Drupal\views\ViewsData;
/**
* Tests the fetching of views data.
*
* @see hook_views_data
*/
class ViewsDataTest extends ViewUnitTestBase {
/**
* Stores the views data cache service used by this test.
*
* @var \Drupal\views\ViewsData
*/
protected $viewsData;
/**
* Stores a count for hook_views_data being invoked.
*
* @var int
*/
protected $count = 0;
/**
* The memory backend to use for the test.
*
* @var \Drupal\Core\Cache\MemoryCounterBackend
*/
protected $memoryCounterBackend;
public static function getInfo() {
return array(
'name' => 'Views data',
'description' => 'Tests the fetching of views data.',
'group' => 'Views',
);
}
protected function setUp() {
parent::setUp();
$this->memoryCounterBackend = new MemoryCounterBackend('views_info');
$this->state = $this->container->get('state');
$this->initViewsData();
}
/**
* Tests the views.views_data service.
*
* @see \Drupal\views\ViewsData
*/
public function testViewsFetchData() {
$table_name = 'views_test_data';
$random_table_name = $this->randomName();
// Invoke expected data directly from hook_views_data implementations.
$expected_data = $this->container->get('module_handler')->invokeAll('views_data');
// Verify that views_test_data_views_data() has only been called once after
// calling clear().
$this->startCount();
$this->viewsData->get();
// Test views data has been invoked.
$this->assertCountIncrement();
// Clear the storage/cache.
$this->viewsData->clear();
// Get the data again.
$this->viewsData->get();
$this->viewsData->get($table_name);
$this->viewsData->get($random_table_name);
// Verify that view_test_data_views_data() has run once.
$this->assertCountIncrement();
// Get the data again.
$this->viewsData->get();
$this->viewsData->get($table_name);
$this->viewsData->get($random_table_name);
// Verify that view_test_data_views_data() has not run again.
$this->assertCountIncrement(FALSE);
// Clear the views data, and test all table data.
$this->viewsData->clear();
$this->startCount();
$data = $this->viewsData->get();
$this->assertEqual($data, $expected_data, 'Make sure fetching all views data by works as expected.');
// Views data should be invoked once.
$this->assertCountIncrement();
// Calling get() again, the count for this table should stay the same.
$data = $this->viewsData->get();
$this->assertEqual($data, $expected_data, 'Make sure fetching all cached views data works as expected.');
$this->assertCountIncrement(FALSE);
// Clear the views data, and test data for a specific table.
$this->viewsData->clear();
$this->startCount();
$data = $this->viewsData->get($table_name);
$this->assertEqual($data, $expected_data[$table_name], 'Make sure fetching views data by table works as expected.');
// Views data should be invoked once.
$this->assertCountIncrement();
// Calling get() again, the count for this table should stay the same.
$data = $this->viewsData->get($table_name);
$this->assertEqual($data, $expected_data[$table_name], 'Make sure fetching cached views data by table works as expected.');
$this->assertCountIncrement(FALSE);
// Test that this data is present if all views data is returned.
$data = $this->viewsData->get();
$this->assertTrue(isset($data[$table_name]), 'Make sure the views_test_data info appears in the total views data.');
$this->assertEqual($data[$table_name], $expected_data[$table_name], 'Make sure the views_test_data has the expected values.');
// Clear the views data, and test data for an invalid table.
$this->viewsData->clear();
$this->startCount();
// All views data should be requested on the first try.
$data = $this->viewsData->get($random_table_name);
$this->assertEqual($data, array(), 'Make sure fetching views data for an invalid table returns an empty array.');
$this->assertCountIncrement();
// Test no data is rebuilt when requesting an invalid table again.
$data = $this->viewsData->get($random_table_name);
$this->assertEqual($data, array(), 'Make sure fetching views data for an invalid table returns an empty array.');
$this->assertCountIncrement(FALSE);
}
/**
* Ensures that cache entries are only set and get when necessary.
*/
public function testCacheRequests() {
// Request the same table 5 times. The caches are empty at this point, so
// what will happen is that it will first check for a cache entry for the
// given table, get a cache miss, then try the cache entry for all tables,
// which does not exist yet either. As a result, it rebuilds the information
// and writes a cache entry for all tables and the requested table.
$table_name = 'views_test_data';
for ($i = 0; $i < 5; $i++) {
$this->viewsData->get($table_name);
}
// Assert cache set and get calls.
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:views_test_data:en'), 1, 'Requested the cache for the table-specific cache entry.');
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:en'), 1, 'Requested the cache for all tables.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:views_test_data:en'), 1, 'Wrote the cache for the requested once.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:en'), 1, 'Wrote the cache for the all tables once.');
// Re-initialize the views data cache to simulate a new request and repeat.
// We have a warm cache now, so this will only request the tables-specific
// cache entry and return that.
$this->initViewsData();
for ($i = 0; $i < 5; $i++) {
$this->viewsData->get($table_name);
}
// Assert cache set and get calls.
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:views_test_data:en'), 1, 'Requested the cache for the table-specific cache entry.');
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:en'), 0, 'Did not request to load the cache entry for all tables.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:views_test_data:en'), 0, 'Did not write the cache for the requested table.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:en'), 0, 'Did not write the cache for all tables.');
// Re-initialize the views data cache to simulate a new request and request
// a different table. This will fail to get a table specific cache entry,
// load the cache entry for all tables and save a cache entry for this table
// but not all.
$this->initViewsData();
$another_table_name = 'views';
for ($i = 0; $i < 5; $i++) {
$this->viewsData->get($another_table_name);
}
// Assert cache set and get calls.
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:views:en'), 1, 'Requested the cache for the table-specific cache entry.');
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:en'), 1, 'Requested the cache for all tables.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:views:en'), 1, 'Wrote the cache for the requested once.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:en'), 0, 'Did not write the cache for all tables.');
// Re-initialize the views data cache to simulate a new request and request
// a non-existing table. This will result in the same cache requests as we
// explicitly write an empty cache entry for non-existing tables to avoid
// unecessary requests in those situations. We do have to load the cache
// entry for all tables to check if the table does exist or not.
$this->initViewsData();
$non_existing_table = $this->randomName();
for ($i = 0; $i < 5; $i++) {
$this->viewsData->get($non_existing_table);
}
// Assert cache set and get calls.
$this->assertEqual($this->memoryCounterBackend->getCounter('get', "views_data:$non_existing_table:en"), 1, 'Requested the cache for the table-specific cache entry.');
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:en'), 1, 'Requested the cache for all tables.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', "views_data:$non_existing_table:en"), 1, 'Wrote the cache for the requested once.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:en'), 0, 'Did not write the cache for all tables.');
// Re-initialize the views data cache to simulate a new request and request
// the same non-existing table. This will load the table-specific cache
// entry and return the stored empty array for that.
$this->initViewsData();
for ($i = 0; $i < 5; $i++) {
$this->viewsData->get($non_existing_table);
}
// Assert cache set and get calls.
$this->assertEqual($this->memoryCounterBackend->getCounter('get', "views_data:$non_existing_table:en"), 1, 'Requested the cache for the table-specific cache entry.');
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:en'), 0, 'Did not request to load the cache entry for all tables.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', "views_data:$non_existing_table:en"), 0, 'Did not write the cache for the requested table.');
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:en'), 0, 'Did not write the cache for all tables.');
// Re-initialize the views data cache and repeat with no specified table.
// This should only load the cache entry for all tables.
$this->initViewsData();
for ($i = 0; $i < 5; $i++) {
$this->viewsData->get();
}
// This only requested the full information. No other cache requests should
// have been made.
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:views_test_data:en'), 0);
$this->assertEqual($this->memoryCounterBackend->getCounter('get', 'views_data:en'), 1);
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:views_test_data:en'), 0);
$this->assertEqual($this->memoryCounterBackend->getCounter('set', 'views_data:en'), 0);
}
/**
* Initializes a new ViewsData instance and resets the cache backend.
*/
protected function initViewsData() {
$this->memoryCounterBackend->resetCounter();
$this->viewsData = new ViewsData($this->memoryCounterBackend, $this->container->get('config.factory'), $this->container->get('module_handler'), $this->container->get('language_manager'));
}
/**
* Starts a count for hook_views_data being invoked.
*/
protected function startCount() {
$count = $this->state->get('views_test_data_views_data_count');
$this->count = isset($count) ? $count : 0;
}
/**
* Asserts that the count for hook_views_data either equal or has increased.
*
* @param bool $equal
* Whether to assert that the count should be equal. Defaults to FALSE.
*/
protected function assertCountIncrement($increment = TRUE) {
if ($increment) {
// If an incremented count is expected, increment this now.
$this->count++;
$message = 'hook_views_data has been invoked.';
}
else {
$message = 'hook_views_data has not been invoked';
}
$this->assertEqual($this->count, $this->state->get('views_test_data_views_data_count'), $message);
}
/**
* Overrides Drupal\views\Tests\ViewTestBase::viewsData().
*/
protected function viewsData() {
$data = parent::viewsData();
// Tweak the views data to have a base for testing
// \Drupal\views\ViewsDataHelper::fetchFields().
unset($data['views_test_data']['id']['field']);
unset($data['views_test_data']['name']['argument']);
unset($data['views_test_data']['age']['filter']);
unset($data['views_test_data']['job']['sort']);
$data['views_test_data']['created']['area']['id'] = 'text';
$data['views_test_data']['age']['area']['id'] = 'text';
$data['views_test_data']['age']['area']['sub_type'] = 'header';
$data['views_test_data']['job']['area']['id'] = 'text';
$data['views_test_data']['job']['area']['sub_type'] = array('header', 'footer');
return $data;
}
/**
* Tests the fetchBaseTables() method.
*/
public function testFetchBaseTables() {
// Enabled node module so there is more than 1 base table to test.
$this->enableModules(array('node'));
$data = $this->viewsData->get();
$base_tables = $this->viewsData->fetchBaseTables();
// Test the number of tables returned and their order.
$this->assertEqual(count($base_tables), 3, 'The correct amount of base tables were returned.');
$this->assertIdentical(array_keys($base_tables), array('node', 'node_revision', 'views_test_data'), 'The tables are sorted as expected.');
// Test the values returned for each base table.
$defaults = array(
'title' => '',
'help' => '',
'weight' => 0,
);
foreach ($base_tables as $base_table => $info) {
// Merge in default values as in fetchBaseTables().
$expected = $data[$base_table]['table']['base'] += $defaults;
foreach ($defaults as $key => $default) {
$this->assertEqual($info[$key], $expected[$key]);
}
}
}
}
......@@ -113,7 +113,7 @@ public function __construct(CacheBackendInterface $cache_backend, ConfigFactory
public function get($key = NULL) {
if ($key) {
if (!isset($this->storage[$key])) {
// Prepare a cache ID.
// Prepare a cache ID for get and set.
$cid = $this->baseCid . ':' . $key;
$from_cache = FALSE;
......@@ -135,15 +135,11 @@ public function get($key = NULL) {
$this->storage[$key] = array();
}
// Create a cache entry for the requested table.
$this->cacheBackend->set($this->prepareCid($cid), $this->storage[$key]);
$this->cacheSet($cid, $this->storage[$key]);
}
}
if (isset($this->storage[$key])) {
return $this->storage[$key];
}
// If the key is invalid, return an empty array.
return array();
return $this->storage[$key];
}
else {
if (!$this->fullyLoaded) {
......@@ -172,6 +168,18 @@ protected function cacheGet($cid) {
return $this->cacheBackend->get($this->prepareCid($cid));
}
/**
* Sets data to the cache backend.
*
* @param string $cid
* The cache ID to set.
* @param mixed $data
* The data that will be cached.
*/
protected function cacheSet($cid, $data) {
return $this->cacheBackend->set($this->prepareCid($cid), $data);
}
/**
* Prepares the cache ID by appending a language code.
*
......@@ -206,7 +214,7 @@ protected function getData() {
$this->processEntityTypes($data);
// Keep a record with all data.
$this->cacheBackend->set($this->prepareCid($this->baseCid), $data);
$this->cacheSet($this->baseCid, $data);
return $data;
}
......
This diff is collapsed.
Markdown is supported
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