SystemConfigFormTestBase.php in Zircon Profile 8

Contains \Drupal\system\Tests\System\SystemConfigFormTestBase.

Namespace

Drupal\system\Tests\System

File

core/modules/system/src/Tests/System/SystemConfigFormTestBase.php

<?php

/**
 * @file
 * Contains \Drupal\system\Tests\System\SystemConfigFormTestBase.
 */
namespace Drupal\system\Tests\System;

use Drupal\Core\Form\FormState;
use Drupal\simpletest\WebTestBase;

/**
 * Full generic test suite for any form that data with the configuration system.
 *
 * @see UserAdminSettingsFormTest
 *   For a full working implementation.
 */
abstract class SystemConfigFormTestBase extends WebTestBase {

  /**
   * Form ID to use for testing.
   *
   * @var \Drupal\Core\Form\FormInterface.
   */
  protected $form;

  /**
   * Values to use for testing.
   *
   * Contains details for form key, configuration object name, and config key.
   * Example:
   * @code
   *   array(
   *     'user_mail_cancel_confirm_body' => array(
   *       '#value' => $this->randomString(),
   *       '#config_name' => 'user.mail',
   *       '#config_key' => 'cancel_confirm.body',
   *     ),
   *   );
   * @endcode
   *
   * @var array
   */
  protected $values;

  /**
   * Submit the system_config_form ensure the configuration has expected values.
   */
  public function testConfigForm() {

    // Programmatically submit the given values.
    $values = array();
    foreach ($this->values as $form_key => $data) {
      $values[$form_key] = $data['#value'];
    }
    $form_state = (new FormState())
      ->setValues($values);
    \Drupal::formBuilder()
      ->submitForm($this->form, $form_state);

    // Check that the form returns an error when expected, and vice versa.
    $errors = $form_state
      ->getErrors();
    $valid_form = empty($errors);
    $args = array(
      '%values' => print_r($values, TRUE),
      '%errors' => $valid_form ? t('None') : implode(' ', $errors),
    );
    $this
      ->assertTrue($valid_form, format_string('Input values: %values<br/>Validation handler errors: %errors', $args));
    foreach ($this->values as $data) {
      $this
        ->assertEqual($data['#value'], $this
        ->config($data['#config_name'])
        ->get($data['#config_key']));
    }
  }

}

Classes

Name	Description
SystemConfigFormTestBase	Full generic test suite for any form that data with the configuration system.