1 form.test FormsTestCase::testRequiredCheckboxesRadio()

Tests validation for required checkbox, select, and radio elements.

Submits a test form containing several types of form elements. The form is submitted twice, first without values for required fields and then with values. Each submission is checked for relevant error messages.

See also



core/modules/simpletest/tests/form.test, line 138
Unit tests for the Backdrop Form API.




function testRequiredCheckboxesRadio() {
  $form = $form_state = array();
  $form = form_test_validate_required_form($form, $form_state);

  // Attempt to submit the form with no required fields set.
  $edit = array();
  $this->backdropPost('form-test/validate-required', $edit, 'Submit');

  // The only error messages that should appear are the relevant 'required'
  // messages for each field.
  $expected = array();
  foreach (array('textfield', 'checkboxes', 'select', 'radios') as $key) {
    if (isset($form[$key]['#required_message'])) {
      $expected[] = $form[$key]['#required_message'];
    elseif (isset($form[$key]['#form_test_expected_message'])) {
      $expected[] = $form[$key]['#form_test_expected_message'];

  // Check the page for error messages.
  $errors = $this->xpath('//div[contains(@class, "error")]//li');
  foreach ($errors as $error) {
    $expected_key = array_search($error[0], $expected);
    // If the error message is not one of the expected messages, fail.
    if ($expected_key === FALSE) {
      $this->fail(format_string("Unexpected error message: @error", array('@error' => $error[0])));
    // Remove the expected message from the list once it is found.
    else {

  // Fail if any expected messages were not found.
  foreach ($expected as $not_found) {
    $this->fail(format_string("Found error message: @error", array('@error' => $not_found)));

  // Verify that input elements are still empty.
  $this->assertFieldByName('textfield', '');
  $this->assertOptionSelected('edit-select', '');

  // Verify that the #element_validate handler on the select list did not
  // fire when the field was left empty.
  $this->assertNoRaw('Please select the "foo" option.');

  // Submit again with required fields missing but a value in the select
  // field, which will fire its #element_validate handler while other required
  // fields are not completed.
  $edit = array(
    'select' => 'bar',
  $this->backdropPost(NULL, $edit, 'Submit');
  $this->assertRaw('Please select the "foo" option.');

  // Submit again with required fields set and verify that there are no
  // error messages.
  $edit = array(
    'textfield' => $this->randomString(),
    'checkboxes[foo]' => TRUE,
    'select' => 'foo',
    'radios' => 'bar',
  $this->backdropPost(NULL, $edit, 'Submit');
  $this->assertNoFieldByXpath('//div[contains(@class, "error")]', FALSE, 'No error message is displayed when all required fields are filled.');
  $this->assertRaw("The form_test_validate_required_form form was submitted successfully.", 'Validation form submitted successfully.');