validator = \Drupal::service('webform.elements_validator');
}
/**
* Tests validating elements.
*/
public function testValidate(): void {
$tests = [
/*
[
'getElementsRaw' => '', // Elements.
'getElementsOriginalRaw' => '', // Original elements.
'messages' => [], // Validation error message.
],
*/
// Check required.
[
'getElementsRaw' => '',
'getElementsOriginalRaw' => '',
'messages' => [
'Elements are required',
],
],
// Check elements are an array.
[
'getElementsRaw' => 'string',
'messages' => [
'Elements are not valid. YAML must contain an associative array of elements.',
],
],
// Check names.
[
'getElementsRaw' => "Not Valid:
'#type': textfield",
'messages' => [
'The element key Not Valid on line 1 must contain only lowercase letters, numbers, and underscores.',
],
],
// Check duplicate names.
[
'getElementsRaw' => "name:
'#type': textfield
duplicate:
name:
'#type': textfield",
'messages' => [
'Elements contain a duplicate element key name found on lines 1 and 4.',
],
],
// Check duplicate name with single and double quotes.
[
'getElementsRaw' => "name :
'#type': textfield
duplicate:
name:
'#type': textfield",
'messages' => [
'Elements contain a duplicate element key name found on lines 1 and 4.',
],
],
// Check reserved names.
[
'getElementsRaw' => "name:
'#type': textfield
duplicate:
add:
'#type': textfield",
'messages' => [
'The element key add on line 4 is a reserved key.',
],
],
// Check ignored properties.
[
'getElementsRaw' => "'tree':
'#tree': true
'#submit' : 'function_name'",
'messages' => [
'Elements contain an unsupported #tree property found on line 2.',
'Elements contain an unsupported #submit property found on line 3.',
],
],
// Check validate submissions.
[
'getElementsRaw' => "name_changed:
'#type': 'textfield'",
'getElementsOriginalRaw' => "name:
'#type': 'textfield'",
'messages' => [
'The name element can not be removed because the Test webform has results.',
],
],
// Check validate hierarchy.
[
'getElementsRaw' => 'empty: empty',
'getElementsOriginalRaw' => 'empty: empty',
'getElementsInitializedAndFlattened' => [
'leaf_parent' => [
'#type' => 'textfield',
'#webform_key' => 'leaf_parent',
'#webform_children' => TRUE,
],
'root' => [
'#type' => 'webform_wizard_page',
'#webform_key' => 'root',
'#webform_parent_key' => TRUE,
],
],
'messages' => [
'The leaf_parent (textfield) is a webform element that can not have any child elements.',
'The root (webform_wizard_page) is a root element that can not be used as child to another element',
],
],
// Check validate table hierarchy.
[
'getElementsRaw' => 'empty: empty',
'getElementsOriginalRaw' => 'empty: empty',
'getElementsInitializedAndFlattened' => [
'table' => [
'#type' => 'webform_table',
'#webform_key' => 'table',
],
'table_row' => [
'#type' => 'webform_table_row',
'#webform_key' => 'table_row',
'#webform_parent_key' => 'table',
],
'table_row_invalid' => [
'#type' => 'webform_table_row',
'#webform_key' => 'table_row',
'#webform_parent_key' => NULL,
],
],
'messages' => [
'The table_row_invalid (webform_table_row) must be with in a Table (webform_table) element.',
],
],
// Check validate pages.
[
'getElementsRaw' => "page:
'#type': webform_wizard_page
card:
'#type': webform_card",
'messages' => [
'Pages and cards cannot be used in the same webform. Please remove or convert the pages/cards to the same element type.',
],
],
];
// Check invalid YAML.
// Test is customized depending on if the PECL YAML component is installed.
// @see https://www.drupal.org/node/1920902#comment-11418117
if (function_exists('yaml_parse')) {
$test[] = [
'getElementsRaw' => "not\nvalid\nyaml",
'messages' => [
'Elements are not valid. YAML must contain an associative array of elements.',
],
];
$test[] = [
'getElementsRaw' => "not:\nvalid\nyaml",
'messages' => [
'Elements are not valid. yaml_parse(): scanning error encountered during parsing: could not find expected ':' (line 3, column 1), context while scanning a simple key (line 2, column 1)',
],
];
}
else {
$test[] = [
'getElementsRaw' => "not\nvalid\nyaml",
'messages' => [
'Elements are not valid. Unable to parse at line 1 (near "not").',
],
];
}
foreach ($tests as $test) {
$test += [
'getElementsRaw' => '',
'getElementsOriginalRaw' => '',
'getElementsInitializedAndFlattened' => [],
'hasSubmissions' => TRUE,
'label' => 'Test',
'toUrl' => Url::fromUri('http://example.com'),
'messages' => [],
];
/** @var \Drupal\webform\WebformInterface $webform */
$webform = $this->createMock('\Drupal\webform\WebformInterface');
$methods = $test;
unset($methods['messages']);
foreach ($methods as $method => $returnValue) {
$webform->expects($this->any())
->method($method)
->willReturn($returnValue);
}
$messages = $this->validator->validate($webform);
foreach ($messages as $index => $message) {
$messages[$index] = (string) $message;
}
$this->assertEquals($messages, $test['messages']);
}
}
}