function ActionsFormTest::dataActionsFormWidgets
Provides data for testActionsFormWidgets().
Return value
array The test data array. The top level keys are free text but should be short and relate to the test case. The values are ordered arrays of test case data with elements that must appear in the following order:
- Machine name of the action being tested.
- (optional) Required values to enter on the Context form. This is an associative array with keys equal to the field names and values equal to the required field values.
- (optional) Values for fields that have defaults. This is an associative array with keys equal to the field names and values equal to the field values. These are used on the second edit, to alter the fields that have been saved with their default value.
- (optional) Widget types we expect to see on the Context form. This is an associative array with keys equal to the field names as above, and values equal to expected widget type.
- (optional) Names of fields for which the selector/direct input button needs pressing to 'data selection' before the field value is entered.
- (optional) Provides values. This is an associative array with keys equal to the field names and values equal to values to set.
File
-
tests/
src/ Functional/ ActionsFormTest.php, line 175
Class
- ActionsFormTest
- Tests that each Rules Action can be edited.
Namespace
Drupal\Tests\rules\FunctionalCode
public function dataActionsFormWidgets() {
// Instead of directly returning the full set of test data, create variable
// $data to hold it. This allows for manipulation before the final return.
$data = [
// Data.
'1. Data calculate value' => [
// Machine name.
'rules_data_calculate_value',
// Required values.
[
'input-1' => '3',
'operator' => '*',
'input-2' => '4',
],
// Defaulted values.
[],
// Widgets.
[
'input-1' => 'text-input',
'operator' => 'text-input',
'input-2' => 'text-input',
],
// Selectors.
[],
// Provides.
[
'result' => 'new_named_variable',
],
],
'2. Data convert' => [
'rules_data_convert',
[
'value' => 'node.uid',
'target-type' => 'string',
],
[
'rounding-behavior' => 'up',
],
],
'3. List item add' => [
'rules_list_item_add',
[
'list' => 'node.uid.entity.roles',
'item' => '1',
],
[
'unique' => TRUE,
'position' => 'start',
],
],
'4. List item remove' => [
'rules_list_item_remove',
[
'list' => 'node.uid.entity.roles',
'item' => '1',
],
],
'5. Data set - direct' => [
'rules_data_set',
[
'data' => 'node.title',
],
[
'value' => 'abc',
],
],
'6. Data set - selector' => [
'rules_data_set',
[
'data' => 'node.title',
'value' => '@user.current_user_context:current_user.name.value',
],
[],
[],
[
'value',
],
],
'7. Variable add' => [
'rules_variable_add',
[
'type' => 'integer',
'value' => 'node.nid',
],
],
// Entity.
'8. Entity delete' => [
'rules_entity_delete',
[
'entity' => 'node',
],
],
'9. Entity fetch by field - selector' => [
// Machine name.
'rules_entity_fetch_by_field',
// Required values.
[
'type' => 'node',
'field-name' => 'nid',
'field-value' => 'node.uid',
],
// Defaulted values.
[
'limit' => 5,
],
// Widgets.
[],
// Selectors.
[
'field-value',
],
// Provides.
[
'entity-fetched' => 'new_named_variable',
],
],
'10. Entity fetch by field - direct' => [
'rules_entity_fetch_by_field',
[
'type' => 'node',
'field-name' => 'sticky',
'field-value' => 1,
],
],
'11. Entity fetch by id' => [
'rules_entity_fetch_by_id',
[
'type' => 'node',
'entity-id' => 123,
],
],
'12. Entity save' => [
'rules_entity_save',
[
'entity' => 'node',
],
[
'immediate' => TRUE,
],
],
// Content.
'13. Entity create node' => [
'rules_entity_create:node',
[
'type' => 'article',
'title' => 'abc',
],
],
'14. Node make sticky' => [
'rules_node_make_sticky',
[
'node' => 'node',
],
],
'15. Node make unsticky' => [
'rules_node_make_unsticky',
[
'node' => 'node',
],
],
'16. Node publish' => [
'rules_node_publish',
[
'node' => 'node',
],
],
'17.Node unpublish' => [
'rules_node_unpublish',
[
'node' => 'node',
],
],
'18. Node promote' => [
'rules_node_promote',
[
'node' => 'node',
],
],
'19. Node unpromote' => [
'rules_node_unpromote',
[
'node' => 'node',
],
],
// Path.
'20. Path alias create' => [
'rules_path_alias_create',
[
'source' => '/node/1',
'alias' => 'abc',
],
[
'language' => 'en',
],
],
'21. Entity path alias create' => [
'rules_entity_path_alias_create:entity:node',
[
'entity' => 'node',
'alias' => 'abc',
],
],
'22. Path alias delete by alias' => [
'rules_path_alias_delete_by_alias',
[
'alias' => 'abc',
],
],
'23. Path alias delete by path' => [
'rules_path_alias_delete_by_path',
[
'path' => '/node/1',
],
],
// System.
'24. Page redirect' => [
'rules_page_redirect',
[
'url' => '/node/1',
],
],
'25. Email to users of role' => [
'rules_email_to_users_of_role',
[
'roles' => 'test-editor',
'subject' => 'Hello',
'message' => "Some text\nLine two",
],
[
'reply' => 'test@example.com',
'language' => 'und',
],
[
'message' => 'textarea',
],
],
'26. System message' => [
'rules_system_message',
[
'message' => 'Some text',
],
[
'type' => 'warning',
'repeat' => 0,
],
],
'27. Send email - direct input' => [
'rules_send_email',
[
'to' => 'test@example.com',
'subject' => 'Some testing subject',
'message' => 'Test with direct input of recipients',
],
[
'reply' => 'test@example.com',
'language' => 'en',
],
[
'message' => 'textarea',
],
],
'28. Send email - data selector for address' => [
'rules_send_email',
[
'to' => 'node.uid.entity.mail.value',
'subject' => 'Some testing subject',
'message' => 'Test with selector input of node author',
],
[
'reply' => 'test@example.com',
],
[
'message' => 'textarea',
],
[
'to',
],
],
// User.
'29. Entity create user' => [
'rules_entity_create:user',
// The name should be required, but can save with blank name.
// @todo fix this. Then move 'name' into the required array.
[],
[
'name' => 'fred',
],
],
'30. Send account email' => [
'rules_send_account_email',
[
'user' => 'node.uid',
'email-type' => 'password_reset',
],
],
'31. User block' => [
'rules_user_block',
[
'user' => '@user.current_user_context:current_user',
],
[],
[],
[
'user',
],
],
'32. User role add' => [
'rules_user_role_add',
[
'user' => '@user.current_user_context:current_user',
'roles' => 'test-editor',
],
[],
[],
[
'user',
],
],
'33. User role remove' => [
'rules_user_role_remove',
[
'user' => '@user.current_user_context:current_user',
'roles' => 'test-editor',
],
],
'34. Unblock user' => [
'rules_user_unblock',
[
'user' => '@user.current_user_context:current_user',
],
[],
[],
[
'user',
],
],
// Ban.
'35. Ban IP' => [
'rules_ban_ip',
[],
[
'ip' => '192.0.2.1',
],
],
'36. Unban IP' => [
'rules_unban_ip',
[],
[
'ip' => '192.0.2.1',
],
],
];
// Selecting the 'to' email address using data selector will not work until
// single data selector values with multiple = True are converted to arrays.
// Error "Expected a list data type ... but got a email data type instead".
// @see https://www.drupal.org/project/rules/issues/2723259
// @todo Delete this unset() when the above issue is fixed.
unset($data['28. Send email - data selector for address']);
// Use unset $data['The key to remove']; to remove a temporarily unwanted
// item, use return [$data['Key to test'], $data['Another']]; to selectively
// test some items, or use return $data; to test everything.
return $data;
}