public function ActionsFormTest::dataActionsFormWidgets in Rules 8.3

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 condition being tested.
• (optional) Values to enter on the Context form. This is an associative array with keys equal to the field names and values equal to the field values.
• (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.

File

tests/src/Functional/ActionsFormTest.php, line 149

Class

ActionsFormTest

Tests that each Rules Action can be editted.

Namespace

Drupal\Tests\rules\Functional

Code

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 calculate value' => [
      // Machine name.
      'rules_data_calculate_value',
      // Values.
      [
        'input-1' => '3',
        'operator' => '*',
        'input-2' => '4',
      ],
      // Widgets.
      [
        'input-1' => 'text-input',
        'operator' => 'text-input',
        'input-2' => 'text-input',
      ],
    ],
    'Data convert' => [
      'rules_data_convert',
      [
        'value' => 'node.uid',
        'target-type' => 'string',
      ],
    ],
    'List item add' => [
      'rules_list_item_add',
      [
        'list' => 'node.uid.entity.roles',
        'item' => '1',
        'unique' => TRUE,
        'position' => 'start',
      ],
    ],
    'List item remove' => [
      'rules_list_item_remove',
      [
        'list' => 'node.uid.entity.roles',
        'item' => '1',
      ],
    ],
    'Data set - direct' => [
      'rules_data_set',
      [
        'data' => 'node.title',
        'value' => 'abc',
      ],
    ],
    'Data set - selector' => [
      // Machine name.
      'rules_data_set',
      // Values.
      [
        'data' => 'node.title',
        'value' => '@user.current_user_context:current_user.name.value',
      ],
      // Widgets.
      [],
      // Selectors.
      [
        'value',
      ],
    ],
    'Entity create node' => [
      'rules_entity_create:node',
      [
        'type' => 'article',
        'title' => 'abc',
      ],
    ],
    'Entity create user' => [
      'rules_entity_create:user',
      [
        'name' => 'fred',
      ],
    ],
    'Entity delete' => [
      'rules_entity_delete',
      [
        'entity' => 'node',
      ],
    ],
    'Entity fetch by field - selector' => [
      'rules_entity_fetch_by_field',
      [
        'type' => 'node',
        'field-name' => 'abc',
        'field-value' => 'node.uid',
      ],
      [],
      [
        'field-value',
      ],
    ],
    'Entity fetch by field - direct' => [
      'rules_entity_fetch_by_id',
      [
        'type' => 'node',
        'entity-id' => 123,
      ],
    ],
    'Entity path alias create' => [
      'rules_entity_path_alias_create:entity:node',
      [
        'entity' => 'node',
        'alias' => 'abc',
      ],
    ],
    'Entity save' => [
      'rules_entity_save',
      [
        'entity' => 'node',
        'immediate' => TRUE,
      ],
    ],
    'Node make sticky' => [
      'rules_node_make_sticky',
      [
        'node' => 'node',
      ],
    ],
    'Node make unsticky' => [
      'rules_node_make_unsticky',
      [
        'node' => 'node',
      ],
    ],
    'Node publish' => [
      'rules_node_publish',
      [
        'node' => 'node',
      ],
    ],
    'Node unpublish' => [
      'rules_node_unpublish',
      [
        'node' => 'node',
      ],
    ],
    'Node promote' => [
      'rules_node_promote',
      [
        'node' => 'node',
      ],
    ],
    'Node unpromote' => [
      'rules_node_unpromote',
      [
        'node' => 'node',
      ],
    ],
    'Path alias create' => [
      'rules_path_alias_create',
      [
        'source' => '/node/1',
        'alias' => 'abc',
      ],
    ],
    'Path alias delete by alias' => [
      'rules_path_alias_delete_by_alias',
      [
        'alias' => 'abc',
      ],
    ],
    'Path alias delete by path' => [
      'rules_path_alias_delete_by_path',
      [
        'path' => '/node/1',
      ],
    ],
    'Page redirect' => [
      'rules_page_redirect',
      [
        'url' => '/node/1',
      ],
    ],
    'Send account email' => [
      'rules_send_account_email',
      [
        'user' => 'node.uid',
        'email-type' => 'abc',
      ],
    ],
    'Email to all users of role' => [
      'rules_email_to_users_of_role',
      [
        'roles' => 'editor',
        'subject' => 'Hello',
        'message' => 'Some text',
      ],
      [
        'message' => 'textarea',
      ],
    ],
    'System message' => [
      'rules_system_message',
      [
        'message' => 'Some text',
      ],
    ],
    'Send email - direct input' => [
      'rules_send_email',
      [
        'to' => 'test@example.com',
        'subject' => 'Some testing subject',
        'message' => 'Test with direct input of recipients',
      ],
      [
        'message' => 'textarea',
      ],
    ],
    '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',
      ],
      [
        'message' => 'textarea',
      ],
      [
        'to',
      ],
    ],
    'User block' => [
      'rules_user_block',
      [
        'user' => '@user.current_user_context:current_user',
      ],
      [],
      [
        'user',
      ],
    ],
    'User role add' => [
      'rules_user_role_add',
      [
        'user' => '@user',
        'roles' => 'Editor',
      ],
    ],
    'User role remove' => [
      'rules_user_role_remove',
      [
        'user' => '@user',
        'roles' => 'Editor',
      ],
    ],
    'Unblock user' => [
      'rules_user_unblock',
      [
        'user' => '@user',
      ],
    ],
    'Variable add' => [
      'rules_variable_add',
      [
        'type' => 'integer',
        'value' => 'node.nid',
      ],
    ],
    'Ban IP - empty' => [
      'rules_ban_ip',
      [
        'ip' => '',
      ],
    ],
    'Ban IP - value' => [
      'rules_ban_ip',
      [
        'ip' => '192.0.2.1',
      ],
    ],
    '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.
  // @see https://www.drupal.org/project/rules/issues/2723259
  // @todo Delete this unset() when the above issue is fixed.
  unset($data['Send email - data selector for address']);

  // Use unset $data['The key to remove']; to remove a temporarily unwanted
  // item, use return [$data['The key to test']]; to selectively test just one
  // item, or have return $data; to test everything.
  return $data;
}