You are here

public static function SimpletestResultsForm::addResultForm in Drupal 8

Adds the result form to a $form.

This is a static method so that run-tests.sh can use it to generate a results page completely external to Drupal. This is why the UI strings are not wrapped in t().

Parameters

array $form: The form to attach the results to.

array $results: The simpletest results.

Return value

array A list of tests the passed and failed. The array has two keys, 'pass' and 'fail'. Each contains a list of test classes.

See also

simpletest_script_open_browser()

run-tests.sh

2 calls to SimpletestResultsForm::addResultForm()
SimpletestResultsForm::buildForm in core/modules/simpletest/src/Form/SimpletestResultsForm.php
Form constructor.
_simpletest_run_tests_script_open_browser in core/modules/simpletest/simpletest.module
Display test results from run-tests.sh in a browser.

File

core/modules/simpletest/src/Form/SimpletestResultsForm.php, line 259

Class

SimpletestResultsForm
Test results form for $test_id.

Namespace

Drupal\simpletest\Form

Code

public static function addResultForm(array &$form, array $results) {

  // Transform the test results to be grouped by test class.
  $test_results = [];
  foreach ($results as $result) {
    if (!isset($test_results[$result->test_class])) {
      $test_results[$result->test_class] = [];
    }
    $test_results[$result->test_class][] = $result;
  }
  $image_status_map = static::buildStatusImageMap();

  // Keep track of which test cases passed or failed.
  $filter = [
    'pass' => [],
    'fail' => [],
  ];

  // Summary result widget.
  $form['result'] = [
    '#type' => 'fieldset',
    '#title' => 'Results',
    // Because this is used in a theme-less situation need to provide a
    // default.
    '#attributes' => [],
  ];
  $form['result']['summary'] = $summary = [
    '#theme' => 'simpletest_result_summary',
    '#pass' => 0,
    '#fail' => 0,
    '#exception' => 0,
    '#debug' => 0,
  ];
  \Drupal::service('test_discovery')
    ->registerTestNamespaces();

  // Cycle through each test group.
  $header = [
    'Message',
    'Group',
    'Filename',
    'Line',
    'Function',
    [
      'colspan' => 2,
      'data' => 'Status',
    ],
  ];
  $form['result']['results'] = [];
  foreach ($test_results as $group => $assertions) {

    // Create group details with summary information.
    $info = TestDiscovery::getTestInfo($group);
    $form['result']['results'][$group] = [
      '#type' => 'details',
      '#title' => $info['name'],
      '#open' => TRUE,
      '#description' => $info['description'],
    ];
    $form['result']['results'][$group]['summary'] = $summary;
    $group_summary =& $form['result']['results'][$group]['summary'];

    // Create table of assertions for the group.
    $rows = [];
    foreach ($assertions as $assertion) {
      $row = [];
      $row[] = [
        'data' => [
          '#markup' => $assertion->message,
        ],
      ];
      $row[] = $assertion->message_group;
      $row[] = \Drupal::service('file_system')
        ->basename($assertion->file);
      $row[] = $assertion->line;
      $row[] = $assertion->function;
      $row[] = [
        'data' => $image_status_map[$assertion->status],
      ];
      $class = 'simpletest-' . $assertion->status;
      if ($assertion->message_group == 'Debug') {
        $class = 'simpletest-debug';
      }
      $rows[] = [
        'data' => $row,
        'class' => [
          $class,
        ],
      ];
      $group_summary['#' . $assertion->status]++;
      $form['result']['summary']['#' . $assertion->status]++;
    }
    $form['result']['results'][$group]['table'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];

    // Set summary information.
    $group_summary['#ok'] = $group_summary['#fail'] + $group_summary['#exception'] == 0;
    $form['result']['results'][$group]['#open'] = !$group_summary['#ok'];

    // Store test group (class) as for use in filter.
    $filter[$group_summary['#ok'] ? 'pass' : 'fail'][] = $group;
  }

  // Overall summary status.
  $form['result']['summary']['#ok'] = $form['result']['summary']['#fail'] + $form['result']['summary']['#exception'] == 0;
  return $filter;
}