class PluginBaseTest in Zircon Profile 8
Same name in this branch
- 8 core/tests/Drupal/Tests/Component/Plugin/PluginBaseTest.php \Drupal\Tests\Component\Plugin\PluginBaseTest
- 8 core/modules/views/tests/src/Unit/PluginBaseTest.php \Drupal\Tests\views\Unit\PluginBaseTest
- 8 core/modules/views/src/Tests/Plugin/PluginBaseTest.php \Drupal\views\Tests\Plugin\PluginBaseTest
Same name and namespace in other branches
- 8.0 core/modules/views/tests/src/Unit/PluginBaseTest.php \Drupal\Tests\views\Unit\PluginBaseTest
@coversDefaultClass \Drupal\views\Plugin\views\PluginBase @group views
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\views\Unit\PluginBaseTest
Expanded class hierarchy of PluginBaseTest
File
- core/
modules/ views/ tests/ src/ Unit/ PluginBaseTest.php, line 17 - Contains \Drupal\Tests\views\Unit\PluginBaseTest.
Namespace
Drupal\Tests\views\UnitView source
class PluginBaseTest extends UnitTestCase {
/**
* The test helper plugin to use for the tests.
*
* @var \Drupal\views\Tests\TestHelperPlugin
*/
protected $testHelperPlugin;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this->testHelperPlugin = new TestHelperPlugin(array(), 'default', array());
}
/**
* Tests the unpackOptions method.
*
* @param array $storage
* The storage array to unpack option into.
* @param array $options
* The array of options to unpack.
* @param array $definition
* The definition array, defining default options.
* @param array $expected
* The expected array after unpacking
* @param bool $all
* Whether to unpack all options.
*
* @dataProvider providerTestUnpackOptions
* @covers ::unpackOptions
*/
public function testUnpackOptions($storage, $options, $definition, $expected, $all = FALSE) {
$this->testHelperPlugin
->unpackOptions($storage, $options, $definition, $all);
$this
->assertEquals($storage, $expected);
}
/**
* Tests the setOptionDefault method.
*
* @param array $storage
* The storage array to unpack option into.
* @param array $definition
* The definition array, defining default options.
* @param array $expected
* The expected array after unpacking
*
* @dataProvider providerTestSetOptionDefault
* @covers ::setOptionDefaults
*/
public function testSetOptionDefault($storage, $definition, $expected) {
$this->testHelperPlugin
->testSetOptionDefaults($storage, $definition);
$this
->assertEquals($storage, $expected);
}
/**
* Data provider for testUnpackOptions().
*
* @return array
*/
public function providerTestUnpackOptions() {
$test_parameters = array();
// Set a storage but no value, so the storage value should be kept.
$test_parameters[] = array(
'storage' => array(
'key' => 'value',
),
'options' => array(),
'definition' => array(
'key' => array(
'default' => 'value2',
),
),
'expected' => array(
'key' => 'value',
),
);
// Set a storage and a option value, so the option value should be kept.
$test_parameters[] = array(
'storage' => array(
'key' => 'value',
),
'options' => array(
'key' => 'value2',
),
'definition' => array(
'key' => array(
'default' => 'value3',
),
),
'expected' => array(
'key' => 'value2',
),
'',
);
// Set no storage but an options value, so the options value should be kept.
$test_parameters[] = array(
'storage' => array(),
'options' => array(
'key' => 'value',
),
'definition' => array(
'key' => array(
'default' => 'value2',
),
),
'expected' => array(
'key' => 'value',
),
);
// Set additional options, which aren't part of the definition, so they
// should be ignored if all is set.
$test_parameters[] = array(
'storage' => array(),
'options' => array(
'key' => 'value',
'key2' => 'value2',
),
'definition' => array(
'key' => array(
'default' => 'value2',
),
),
'expected' => array(
'key' => 'value',
),
);
$test_parameters[] = array(
'storage' => array(),
'options' => array(
'key' => 'value',
'key2' => 'value2',
),
'definition' => array(
'key' => array(
'default' => 'value2',
),
),
'expected' => array(
'key' => 'value',
'key2' => 'value2',
),
'all' => TRUE,
);
// Provide multiple options with their corresponding definition.
$test_parameters[] = array(
'storage' => array(),
'options' => array(
'key' => 'value',
'key2' => 'value2',
),
'definition' => array(
'key' => array(
'default' => 'value2',
),
'key2' => array(
'default' => 'value3',
),
),
'expected' => array(
'key' => 'value',
'key2' => 'value2',
),
);
// Set a complex definition structure with a zero and a one level structure.
$test_parameters[] = array(
'storage' => array(),
'options' => array(
'key0' => 'value',
'key1' => array(
'key1:1' => 'value1',
'key1:2' => 'value2',
),
),
'definition' => array(
'key0' => array(
'default' => 'value0',
),
'key1' => array(
'contains' => array(
'key1:1' => array(
'default' => 'value1:1',
),
),
),
),
'expected' => array(
'key0' => 'value',
'key1' => array(
'key1:1' => 'value1',
),
),
);
// Setup a two level structure.
$test_parameters[] = array(
'storage' => array(),
'options' => array(
'key2' => array(
'key2:1' => array(
'key2:1:1' => 'value0',
'key2:1:2' => array(
'key2:1:2:1' => 'value1',
),
),
),
),
'definition' => array(
'key2' => array(
'contains' => array(
'key2:1' => array(
'contains' => array(
'key2:1:1' => array(
'default' => 'value2:1:2:1',
),
'key2:1:2' => array(
'contains' => array(
'key2:1:2:1' => array(
'default' => 'value2:1:2:1',
),
),
),
),
),
),
),
),
'expected' => array(
'key2' => array(
'key2:1' => array(
'key2:1:1' => 'value0',
'key2:1:2' => array(
'key2:1:2:1' => 'value1',
),
),
),
),
);
return $test_parameters;
}
/**
* Data provider for testSetOptionDefault().
*
* @return array
*/
public function providerTestSetOptionDefault() {
$test_parameters = array();
// No definition should change anything on the storage.
$test_parameters[] = array(
'storage' => array(),
'definition' => array(),
'expected' => array(),
);
// Set a single definition, which should be picked up.
$test_parameters[] = array(
'storage' => array(),
'definition' => array(
'key' => array(
'default' => 'value',
),
),
'expected' => array(
'key' => 'value',
),
);
// Set multiple keys, all should be picked up.
$test_parameters[] = array(
'storage' => array(),
'definition' => array(
'key' => array(
'default' => 'value',
),
'key2' => array(
'default' => 'value2',
),
'key3' => array(
'default' => 'value3',
),
),
'expected' => array(
'key' => 'value',
'key2' => 'value2',
'key3' => 'value3',
),
);
// Setup a definition with multiple levels.
$test_parameters[] = array(
'storage' => array(),
'definition' => array(
'key' => array(
'default' => 'value',
),
'key2' => array(
'contains' => array(
'key2:1' => array(
'default' => 'value2:1',
),
'key2:2' => array(
'default' => 'value2:2',
),
),
),
),
'expected' => array(
'key' => 'value',
'key2' => array(
'key2:1' => 'value2:1',
'key2:2' => 'value2:2',
),
),
);
return $test_parameters;
}
/**
* @dataProvider providerTestFilterByDefinedOptions
* @covers ::filterByDefinedOptions
*/
public function testFilterByDefinedOptions($storage, $options, $expected_storage) {
$this->testHelperPlugin
->setDefinedOptions($options);
$this->testHelperPlugin
->filterByDefinedOptions($storage);
$this
->assertEquals($expected_storage, $storage);
}
public function providerTestFilterByDefinedOptions() {
$data = [];
// A simple defined option.
$values_1 = [
'key1' => 'value1',
];
$options_1 = [
'key1' => [
'default' => '',
],
];
$data[] = [
$values_1,
$options_1,
$values_1,
];
// Multiple defined options .
$values_2 = [
'key1' => 'value1',
'key2' => 'value2',
];
$options_2 = [
'key1' => [
'default' => '',
],
'key2' => [
'default' => '',
],
];
$data[] = [
$values_2,
$options_2,
$values_2,
];
// Multiple options, just one defined.
$data[] = [
$values_2,
$options_1,
$values_1,
];
// Nested options, all properly defined.
$data[] = [
[
'sub1' => $values_2,
'sub2' => $values_2,
],
[
'sub1' => [
'contains' => $options_2,
],
'sub2' => [
'contains' => $options_2,
],
],
[
'sub1' => $values_2,
'sub2' => $values_2,
],
];
// Nested options, not all properly defined.
$data[] = [
[
'sub1' => $values_2,
'sub2' => $values_2,
],
[
'sub1' => [
'contains' => $options_2,
],
'sub2' => [
'contains' => $options_1,
],
],
[
'sub1' => $values_2,
'sub2' => $values_1,
],
];
return $data;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginBaseTest:: |
protected | property | The test helper plugin to use for the tests. | |
PluginBaseTest:: |
public | function | ||
PluginBaseTest:: |
public | function | Data provider for testSetOptionDefault(). | |
PluginBaseTest:: |
public | function | Data provider for testUnpackOptions(). | |
PluginBaseTest:: |
protected | function |
Overrides UnitTestCase:: |
|
PluginBaseTest:: |
public | function | @dataProvider providerTestFilterByDefinedOptions @covers ::filterByDefinedOptions | |
PluginBaseTest:: |
public | function | Tests the setOptionDefault method. | |
PluginBaseTest:: |
public | function | Tests the unpackOptions method. | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed in array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. |