class SchemaCheckTraitTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Config/SchemaCheckTraitTest.php \Drupal\KernelTests\Core\Config\SchemaCheckTraitTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Config/SchemaCheckTraitTest.php \Drupal\KernelTests\Core\Config\SchemaCheckTraitTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Config/SchemaCheckTraitTest.php \Drupal\KernelTests\Core\Config\SchemaCheckTraitTest

Tests the functionality of SchemaCheckTrait.

@group config

Hierarchy

Expanded class hierarchy of SchemaCheckTraitTest

File

core/tests/Drupal/KernelTests/Core/Config/SchemaCheckTraitTest.php, line 15

Namespace

Drupal\KernelTests\Core\Config
View source
class SchemaCheckTraitTest extends KernelTestBase {
    use SchemaCheckTrait;
    
    /**
     * The typed config manager.
     *
     * @var \Drupal\Core\Config\TypedConfigManagerInterface
     */
    protected $typedConfig;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'config_test',
        'config_schema_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'config_test',
            'config_schema_test',
        ]);
        $this->typedConfig = \Drupal::service('config.typed');
    }
    
    /**
     * Tests \Drupal\Core\Config\Schema\SchemaCheckTrait.
     *
     * @dataProvider providerCheckConfigSchema
     */
    public function testCheckConfigSchema(string $type_to_validate_against, bool $validate_constraints, array|bool $nulled_expectations, array|bool $no_data_expectations, array $expectations) : void {
        // Test a non existing schema.
        $ret = $this->checkConfigSchema($this->typedConfig, 'config_schema_test.no_schema', $this->config('config_schema_test.no_schema')
            ->get());
        $this->assertFalse($ret);
        // Test an existing schema with valid data.
        $config_data = $this->config('config_test.types')
            ->get();
        $ret = $this->checkConfigSchema($this->typedConfig, 'config_test.types', $config_data);
        $this->assertTrue($ret);
        // Test it is possible to mark any schema type as required (not nullable).
        $nulled_config_data = array_fill_keys(array_keys($config_data), NULL);
        $ret = $this->checkConfigSchema($this->typedConfig, $type_to_validate_against, $nulled_config_data, $validate_constraints);
        $this->assertSame($nulled_expectations, $ret);
        // Add a new key, a new array and overwrite boolean with array to test the
        // error messages.
        $config_data = [
            'new_key' => 'new_value',
            'new_array' => [],
        ] + $config_data;
        $config_data['boolean'] = [];
        $ret = $this->checkConfigSchema($this->typedConfig, $type_to_validate_against, $config_data, $validate_constraints);
        $this->assertEquals($expectations, $ret);
        // Omit all data, this should trigger validation errors for required keys
        // missing.
        $config_data = [];
        $ret = $this->checkConfigSchema($this->typedConfig, $type_to_validate_against, $config_data, $validate_constraints);
        $this->assertEquals($no_data_expectations, $ret);
    }
    public static function providerCheckConfigSchema() : array {
        // Storage type check errors.
        // @see \Drupal\Core\Config\Schema\SchemaCheckTrait::checkValue()
        $expected_storage_null_check_errors = [
            // TRICKY: `_core` is added during installation even if it is absent from
            // core/modules/config/tests/config_test/config/install/config_test.dynamic.dotted.default.yml.
            // @see \Drupal\Core\Config\ConfigInstaller::createConfiguration()
'config_test.types:_core' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
            'config_test.types:array' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Sequence',
            'config_test.types:mapping_with_only_required_keys' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
            'config_test.types:mapping_with_some_required_keys' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
            'config_test.types:mapping_with_only_optional_keys' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
        ];
        $expected_storage_type_check_errors = [
            'config_test.types:new_key' => 'missing schema',
            'config_test.types:new_array' => 'missing schema',
            'config_test.types:boolean' => 'non-scalar value but not defined as an array (such as mapping or sequence)',
        ];
        // Validation constraints violations.
        // @see \Drupal\Core\TypedData\TypedDataInterface::validate()
        $expected_validation_errors = [
            '0' => "[new_key] 'new_key' is not a supported key.",
            '1' => "[new_array] 'new_array' is not a supported key.",
            '2' => '[boolean] This value should be of the correct primitive type.',
        ];
        $basic_cases = [
            'config_test.types, without validation' => [
                'config_test.types',
                FALSE,
                $expected_storage_null_check_errors,
                TRUE,
                $expected_storage_type_check_errors,
            ],
            'config_test.types, with validation' => [
                'config_test.types',
                TRUE,
                $expected_storage_null_check_errors,
                TRUE,
                $expected_storage_type_check_errors + $expected_validation_errors,
            ],
        ];
        // Test that if the exact same schema is reused but now has the constraint
        // "FullyValidatable" specified at the top level, that:
        // 1. `NULL` values now trigger validation errors, except when
        //    `nullable: true` is set.
        // 2. missing required keys now trigger validation errors, except when
        //    `requiredKey: false` is set.
        // @see `type: config_test.types.fully_validatable`
        // @see core/modules/config/tests/config_test/config/schema/config_test.schema.yml
        $expected_storage_null_check_errors = [
            // TRICKY: `_core` is added during installation even if it is absent from
            // core/modules/config/tests/config_test/config/install/config_test.dynamic.dotted.default.yml.
            // @see \Drupal\Core\Config\ConfigInstaller::createConfiguration()
'config_test.types.fully_validatable:_core' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
            'config_test.types.fully_validatable:array' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Sequence',
            'config_test.types.fully_validatable:mapping_with_only_required_keys' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
            'config_test.types.fully_validatable:mapping_with_some_required_keys' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
            'config_test.types.fully_validatable:mapping_with_only_optional_keys' => 'variable type is NULL but applied schema class is Drupal\\Core\\Config\\Schema\\Mapping',
        ];
        $expected_storage_type_check_errors = [
            'config_test.types.fully_validatable:new_key' => 'missing schema',
            'config_test.types.fully_validatable:new_array' => 'missing schema',
            'config_test.types.fully_validatable:boolean' => 'non-scalar value but not defined as an array (such as mapping or sequence)',
        ];
        $opt_in_cases = [
            'config_test.types.fully_validatable, without validation' => [
                'config_test.types.fully_validatable',
                FALSE,
                $expected_storage_null_check_errors,
                TRUE,
                $expected_storage_type_check_errors,
            ],
            'config_test.types.fully_validatable, with validation' => [
                'config_test.types.fully_validatable',
                TRUE,
                $expected_storage_null_check_errors + [
                    '[_core] This value should not be null.',
                    '[array] This value should not be null.',
                    '[boolean] This value should not be null.',
                    '[exp] This value should not be null.',
                    '[float] This value should not be null.',
                    '[float_as_integer] This value should not be null.',
                    '[hex] This value should not be null.',
                    '[int] This value should not be null.',
                    '[string] This value should not be null.',
                    '[string_int] This value should not be null.',
                    '[mapping_with_only_required_keys] This value should not be null.',
                    '[mapping_with_some_required_keys] This value should not be null.',
                    '[mapping_with_only_optional_keys] This value should not be null.',
                ],
                [
                    "[] 'array' is a required key.",
                    "[] 'boolean' is a required key.",
                    "[] 'exp' is a required key.",
                    "[] 'float' is a required key.",
                    "[] 'float_as_integer' is a required key.",
                    "[] 'hex' is a required key.",
                    "[] 'int' is a required key.",
                    "[] 'string' is a required key.",
                    "[] 'string_int' is a required key.",
                    "[] 'nullable_array' is a required key.",
                    "[] 'nullable_boolean' is a required key.",
                    "[] 'nullable_exp' is a required key.",
                    "[] 'nullable_float' is a required key.",
                    "[] 'nullable_float_as_integer' is a required key.",
                    "[] 'nullable_hex' is a required key.",
                    "[] 'nullable_int' is a required key.",
                    "[] 'nullable_octal' is a required key.",
                    "[] 'nullable_string' is a required key.",
                    "[] 'nullable_string_int' is a required key.",
                    "[] 'mapping_with_only_required_keys' is a required key.",
                    "[] 'mapping_with_some_required_keys' is a required key.",
                    "[] 'mapping_with_only_optional_keys' is a required key.",
                ],
                $expected_storage_type_check_errors + $expected_validation_errors + [
                    // For `mapping_with_only_required_keys`: errors for all 4 keys.
3 => "[mapping_with_only_required_keys] 'north' is a required key.",
                    4 => "[mapping_with_only_required_keys] 'east' is a required key.",
                    5 => "[mapping_with_only_required_keys] 'south' is a required key.",
                    6 => "[mapping_with_only_required_keys] 'west' is a required key.",
                    // For `mapping_with_some_required_keys`: errors for 2 required keys.
7 => "[mapping_with_some_required_keys] 'north' is a required key.",
                    8 => "[mapping_with_some_required_keys] 'south' is a required key.",
                ],
            ],
        ];
        return array_merge($basic_cases, $opt_in_cases);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
SchemaCheckTrait::$configName protected property The configuration object name under test.
SchemaCheckTrait::$ignoredPropertyPaths protected static property The ignored property paths.
SchemaCheckTrait::$schema protected property The config schema wrapper object for the configuration object under test.
SchemaCheckTrait::checkConfigSchema public function Checks the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTrait::checkValue protected function Helper method to check data type.
SchemaCheckTrait::isViolationForIgnoredPropertyPath protected static function Determines whether this violation is for an ignored Config property path.
SchemaCheckTraitTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
SchemaCheckTraitTest::$typedConfig protected property The typed config manager.
SchemaCheckTraitTest::providerCheckConfigSchema public static function
SchemaCheckTraitTest::setUp protected function Overrides KernelTestBase::setUp
SchemaCheckTraitTest::testCheckConfigSchema public function Tests \Drupal\Core\Config\Schema\SchemaCheckTrait.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.