class AnnotationProcessingTest

Tests processing of the ContextDefinition annotation.

@group Rules

Hierarchy

Expanded class hierarchy of AnnotationProcessingTest

File

tests/src/Unit/Integration/Engine/AnnotationProcessingTest.php, line 14

Namespace

Drupal\Tests\rules\Unit\Integration\Engine
View source
class AnnotationProcessingTest extends RulesIntegrationTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->enableModule('user');
        // Some of our plugins assume sessions exist:
        $session_manager = $this->prophesize(SessionManagerInterface::class);
        $this->container
            ->set('session_manager', $session_manager->reveal());
    }
    
    /**
     * Make sure @ Translation annotations do not leak out into the wild.
     */
    public function testTranslationSquelching() {
        // Get a sample Rules plugin.
        $plugin = $this->conditionManager
            ->createInstance('rules_list_contains');
        $context = $plugin->getContext('list');
        $definition = $context->getContextDefinition();
        // These can reasonably be either strings or TranslatableMarkup objects,
        // but never Translation objects.
        $label = $definition->getLabel();
        $description = $definition->getDescription();
        $this->assertNotInstanceOf(Translation::class, $label, 'Label is not a Translation object');
        $this->assertNotInstanceOf(Translation::class, $description, 'Description is not a Translation object');
        // Check also the toArray() path.
        $definition = $context->getContextDefinition();
        $values = $definition->toArray();
        $label = $values['label'];
        $description = $values['description'];
        $this->assertNotInstanceOf(Translation::class, $label, "\$values['label'] is not a Translation object");
        $this->assertNotInstanceOf(Translation::class, $description, "\$values['description'] is not a Translation object");
    }
    
    /**
     * Tests if our ContextDefinition annotations are correctly processed.
     *
     * @param string $plugin_type
     *   Type of rules plugin to test (for now, 'action' or 'condition').
     * @param string $plugin_id
     *   Plugin ID for the plugin to be tested.
     * @param string $context_name
     *   The name of the plugin's context to test.
     * @param string $expected
     *   The type of context as defined in the plugin's annotation.
     *
     * @dataProvider provideRulesPlugins
     */
    public function testCheckConfiguration($plugin_type, $plugin_id, $context_name, $expected) {
        $plugin = NULL;
        switch ($plugin_type) {
            case 'action':
                $plugin = $this->actionManager
                    ->createInstance($plugin_id);
                break;
            case 'condition':
                $plugin = $this->conditionManager
                    ->createInstance($plugin_id);
                break;
        }
        $this->assertNotNull($plugin, "{$plugin_type} plugin {$plugin_id} loads");
        $context = $plugin->getContext($context_name);
        $this->assertNotNull($context, "Plugin {$plugin_id} has context {$context_name}");
        $context_def = $context->getContextDefinition();
        $type = $context_def->getDataType();
        $this->assertSame($type, $expected, "Context type for {$context_name} is {$expected}");
    }
    
    /**
     * Provider for plugins to test.
     *
     * Passes $plugin_type, $plugin_id, $context_name, and $expected.
     *
     * @return array
     *   Array of array of values to be passed to our test.
     */
    public function provideRulesPlugins() {
        return [
            [
                'action',
                'rules_user_block',
                'user',
                'entity:user',
            ],
            [
                'condition',
                'rules_entity_is_of_bundle',
                'entity',
                'entity',
            ],
            [
                'condition',
                'rules_node_is_promoted',
                'node',
                'entity:node',
            ],
            [
                'action',
                'rules_list_item_add',
                'list',
                'list',
            ],
            [
                'action',
                'rules_list_item_add',
                'item',
                'any',
            ],
            [
                'action',
                'rules_list_item_add',
                'unique',
                'boolean',
            ],
            [
                'action',
                'rules_list_item_add',
                'position',
                'string',
            ],
        ];
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AnnotationProcessingTest::provideRulesPlugins public function Provider for plugins to test.
AnnotationProcessingTest::setUp protected function Overrides RulesIntegrationTestBase::setUp
AnnotationProcessingTest::testCheckConfiguration public function Tests if our ContextDefinition annotations are correctly processed.
AnnotationProcessingTest::testTranslationSquelching public function Make sure @ Translation annotations do not leak out into the wild.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RulesIntegrationTestBase::$actionManager protected property
RulesIntegrationTestBase::$cacheBackend protected property
RulesIntegrationTestBase::$classResolver protected property The class resolver mock for the typed data manager.
RulesIntegrationTestBase::$conditionManager protected property
RulesIntegrationTestBase::$container protected property The Drupal service container.
RulesIntegrationTestBase::$dataFetcher protected property The data fetcher service.
RulesIntegrationTestBase::$dataFilterManager protected property The data filter manager.
RulesIntegrationTestBase::$enabledModules protected property Array object keyed with module names and TRUE as value.
RulesIntegrationTestBase::$entityFieldManager protected property
RulesIntegrationTestBase::$entityTypeBundleInfo protected property
RulesIntegrationTestBase::$entityTypeManager protected property
RulesIntegrationTestBase::$fieldTypeCategoryManager protected property The field type category info plugin manager.
RulesIntegrationTestBase::$logger protected property A mocked Rules logger.channel.rules_debug service. 6
RulesIntegrationTestBase::$messenger protected property The messenger service.
RulesIntegrationTestBase::$moduleHandler protected property
RulesIntegrationTestBase::$namespaces protected property All setup'ed namespaces.
RulesIntegrationTestBase::$placeholderResolver protected property The placeholder resolver service.
RulesIntegrationTestBase::$rulesDataProcessorManager protected property
RulesIntegrationTestBase::$rulesExpressionManager protected property
RulesIntegrationTestBase::$typedDataManager protected property
RulesIntegrationTestBase::constructModulePath protected function Determines the path to a module's class files.
RulesIntegrationTestBase::enableModule protected function Fakes the enabling of a module and adds its namespace for plugin loading.
RulesIntegrationTestBase::getTypedData protected function Returns a typed data object.
RulesIntegrationTestBase::prophesizeEntity protected function Helper method to mock irrelevant cache methods on entities.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass public static function