class SimpletestTestForm in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/simpletest/src/Form/SimpletestTestForm.php \Drupal\simpletest\Form\SimpletestTestForm
List tests arranged in groups that can be selected and run.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\simpletest\Form\SimpletestTestForm
Expanded class hierarchy of SimpletestTestForm
1 string reference to 'SimpletestTestForm'
- simpletest.routing.yml in core/
modules/ simpletest/ simpletest.routing.yml - core/modules/simpletest/simpletest.routing.yml
File
- core/
modules/ simpletest/ src/ Form/ SimpletestTestForm.php, line 18 - Contains \Drupal\simpletest\Form\SimpletestTestForm.
Namespace
Drupal\simpletest\FormView source
class SimpletestTestForm extends FormBase {
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('renderer'));
}
/**
* Constructs a new SimpletestTestForm.
*
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
*/
public function __construct(RendererInterface $renderer) {
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'simpletest_test_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => $this
->t('Run tests'),
'#tableselect' => TRUE,
'#button_type' => 'primary',
);
$form['clean'] = array(
'#type' => 'fieldset',
'#title' => $this
->t('Clean test environment'),
'#description' => $this
->t('Remove tables with the prefix "simpletest" and temporary directories that are left over from tests that crashed. This is intended for developers when creating tests.'),
'#weight' => 200,
);
$form['clean']['op'] = array(
'#type' => 'submit',
'#value' => $this
->t('Clean environment'),
'#submit' => array(
'simpletest_clean_environment',
),
);
// Do not needlessly re-execute a full test discovery if the user input
// already contains an explicit list of test classes to run.
$user_input = $form_state
->getUserInput();
if (!empty($user_input['tests'])) {
return $form;
}
// JavaScript-only table filters.
$form['filters'] = array(
'#type' => 'container',
'#attributes' => array(
'class' => array(
'table-filter',
'js-show',
),
),
);
$form['filters']['text'] = array(
'#type' => 'search',
'#title' => $this
->t('Search'),
'#size' => 30,
'#placeholder' => $this
->t('Enter test name…'),
'#attributes' => array(
'class' => array(
'table-filter-text',
),
'data-table' => '#simpletest-test-form',
'autocomplete' => 'off',
'title' => $this
->t('Enter at least 3 characters of the test name or description to filter by.'),
),
);
$form['tests'] = array(
'#type' => 'table',
'#id' => 'simpletest-form-table',
'#tableselect' => TRUE,
'#header' => array(
array(
'data' => $this
->t('Test'),
'class' => array(
'simpletest-test-label',
),
),
array(
'data' => $this
->t('Description'),
'class' => array(
'simpletest-test-description',
),
),
),
'#empty' => $this
->t('No tests to display.'),
'#attached' => array(
'library' => array(
'simpletest/drupal.simpletest',
),
),
);
// Define the images used to expand/collapse the test groups.
$image_collapsed = array(
'#theme' => 'image',
'#uri' => 'core/misc/menu-collapsed.png',
'#width' => '7',
'#height' => '7',
'#alt' => $this
->t('Expand'),
'#title' => $this
->t('Expand'),
'#suffix' => '<a href="#" class="simpletest-collapse">(' . $this
->t('Expand') . ')</a>',
);
$image_extended = array(
'#theme' => 'image',
'#uri' => 'core/misc/menu-expanded.png',
'#width' => '7',
'#height' => '7',
'#alt' => $this
->t('Collapse'),
'#title' => $this
->t('Collapse'),
'#suffix' => '<a href="#" class="simpletest-collapse">(' . $this
->t('Collapse') . ')</a>',
);
$form['tests']['#attached']['drupalSettings']['simpleTest']['images'] = [
(string) $this->renderer
->renderPlain($image_collapsed),
(string) $this->renderer
->renderPlain($image_extended),
];
// Generate the list of tests arranged by group.
$groups = simpletest_test_get_all();
foreach ($groups as $group => $tests) {
$form['tests'][$group] = array(
'#attributes' => array(
'class' => array(
'simpletest-group',
),
),
);
// Make the class name safe for output on the page by replacing all
// non-word/decimal characters with a dash (-).
$group_class = 'module-' . strtolower(trim(preg_replace("/[^\\w\\d]/", "-", $group)));
// Override tableselect column with custom selector for this group.
// This group-select-all checkbox is injected via JavaScript.
$form['tests'][$group]['select'] = array(
'#wrapper_attributes' => array(
'id' => $group_class,
'class' => array(
'simpletest-group-select-all',
),
),
);
$form['tests'][$group]['title'] = array(
// Expand/collapse image.
'#prefix' => '<div class="simpletest-image" id="simpletest-test-group-' . $group_class . '"></div>',
'#markup' => '<label for="' . $group_class . '-group-select-all">' . $group . '</label>',
'#wrapper_attributes' => array(
'class' => array(
'simpletest-group-label',
),
),
);
$form['tests'][$group]['description'] = array(
'#markup' => ' ',
'#wrapper_attributes' => array(
'class' => array(
'simpletest-group-description',
),
),
);
// Cycle through each test within the current group.
foreach ($tests as $class => $info) {
$form['tests'][$class] = array(
'#attributes' => array(
'class' => array(
$group_class . '-test',
'js-hide',
),
),
);
$form['tests'][$class]['title'] = array(
'#type' => 'label',
'#title' => '\\' . $info['name'],
'#wrapper_attributes' => array(
'class' => array(
'simpletest-test-label',
'table-filter-text-source',
),
),
);
$form['tests'][$class]['description'] = array(
'#prefix' => '<div class="description">',
'#plain_text' => $info['description'],
'#suffix' => '</div>',
'#wrapper_attributes' => array(
'class' => array(
'simpletest-test-description',
'table-filter-text-source',
),
),
);
}
}
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
global $base_url;
// Test discovery does not run upon form submission.
simpletest_classloader_register();
// This form accepts arbitrary user input for 'tests'.
// An invalid value will cause the $class_name lookup below to die with a
// fatal error. Regular user access mechanisms to this form are intact.
// The only validation effectively being skipped is the validation of
// available checkboxes vs. submitted checkboxes.
// @todo Refactor Form API to allow to POST values without constructing the
// entire form more easily, BUT retaining routing access security and
// retaining Form API CSRF #token security validation, and without having
// to rely on form caching.
$user_input = $form_state
->getUserInput();
if ($form_state
->isValueEmpty('tests') && !empty($user_input['tests'])) {
$form_state
->setValue('tests', $user_input['tests']);
}
$tests_list = array();
foreach ($form_state
->getValue('tests') as $class_name => $value) {
if ($value === $class_name) {
if (is_subclass_of($class_name, 'PHPUnit_Framework_TestCase')) {
$test_type = 'phpunit';
}
else {
$test_type = 'simpletest';
}
$tests_list[$test_type][] = $class_name;
}
}
if (!empty($tests_list)) {
putenv('SIMPLETEST_BASE_URL=' . $base_url);
$test_id = simpletest_run_tests($tests_list, 'drupal');
$form_state
->setRedirect('simpletest.result_form', array(
'test_id' => $test_id,
));
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 3 |
FormBase:: |
protected | property | The logger factory. | |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 3 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
64 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
SimpletestTestForm:: |
protected | property | The renderer. | |
SimpletestTestForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
SimpletestTestForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
SimpletestTestForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
SimpletestTestForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
SimpletestTestForm:: |
public | function | Constructs a new SimpletestTestForm. | |
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Returns a redirect response object for the specified route. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |