TestBase.php 52.6 KB
Newer Older
1
2
3
4
<?php

/**
 * @file
5
 * Contains \Drupal\simpletest\TestBase.
6
7
8
9
 */

namespace Drupal\simpletest;

10
use Drupal\Component\Utility\Crypt;
11
use Drupal\Component\Utility\Random;
12
use Drupal\Component\Utility\SafeMarkup;
13
use Drupal\Core\Database\Database;
14
use Drupal\Core\Config\ConfigImporter;
15
use Drupal\Core\Config\StorageComparer;
16
use Drupal\Core\Database\ConnectionNotDefinedException;
17
use Drupal\Core\Config\StorageInterface;
18
use Drupal\Core\Site\Settings;
19
use Drupal\Core\StreamWrapper\PublicStream;
20
use Drupal\Core\Utility\Error;
21
22
23
24

/**
 * Base class for Drupal tests.
 *
25
 * Do not extend this class directly; use either
26
 * \Drupal\simpletest\WebTestBase or \Drupal\simpletest\KernelTestBase.
27
28
 */
abstract class TestBase {
29
30

  use SessionTestTrait;
31
  use RandomGeneratorTrait;
32

33
34
35
36
37
38
39
  /**
   * The test run ID.
   *
   * @var string
   */
  protected $testId;

40
41
42
43
44
45
46
  /**
   * The site directory of this test run.
   *
   * @var string
   */
  protected $siteDirectory = NULL;

47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
  /**
   * The database prefix of this test run.
   *
   * @var string
   */
  protected $databasePrefix = NULL;

  /**
   * Time limit for the test.
   */
  protected $timeLimit = 500;

  /**
   * Current results of this test case.
   *
   * @var Array
   */
  public $results = array(
    '#pass' => 0,
    '#fail' => 0,
    '#exception' => 0,
    '#debug' => 0,
  );

  /**
   * Assertions thrown in that test case.
   *
   * @var Array
   */
  protected $assertions = array();

  /**
   * This class is skipped when looking for the source of an assertion.
   *
   * When displaying which function an assert comes from, it's not too useful
   * to see "WebTestBase->drupalLogin()', we would like to see the test
   * that called it. So we need to skip the classes defining these helper
   * methods.
   */
  protected $skipClasses = array(__CLASS__ => TRUE);

88
89
90
  /**
   * TRUE if verbose debugging is enabled.
   *
91
   * @var bool
92
   */
93
  public $verbose;
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

  /**
   * Incrementing identifier for verbose output filenames.
   *
   * @var integer
   */
  protected $verboseId = 0;

  /**
   * Safe class name for use in verbose output filenames.
   *
   * Namespaces separator (\) replaced with _.
   *
   * @var string
   */
  protected $verboseClassName;

  /**
   * Directory where verbose output files are put.
   *
   * @var string
   */
  protected $verboseDirectory;

118
119
120
121
122
123
124
125
126
127
128
129
  /**
   * URL to the verbose output file directory.
   *
   * @var string
   */
  protected $verboseDirectoryUrl;

  /**
   * The original configuration (variables), if available.
   *
   * @var string
   * @todo Remove all remnants of $GLOBALS['conf'].
130
   * @see https://www.drupal.org/node/2183323
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
   */
  protected $originalConf;

  /**
   * The original configuration (variables).
   *
   * @var string
   */
  protected $originalConfig;

  /**
   * The original configuration directories.
   *
   * An array of paths keyed by the CONFIG_*_DIRECTORY constants defined by
   * core/includes/bootstrap.inc.
   *
   * @var array
   */
  protected $originalConfigDirectories;

  /**
   * The original container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $originalContainer;

  /**
   * The original file directory, before it was changed for testing purposes.
   *
   * @var string
   */
  protected $originalFileDirectory = NULL;

  /**
   * The original language.
   *
   * @var \Drupal\Core\Language\LanguageInterface
   */
  protected $originalLanguage;

172
173
174
175
176
177
178
  /**
   * The original database prefix when running inside Simpletest.
   *
   * @var string
   */
  protected $originalPrefix;

179
  /**
180
   * The original installation profile.
181
182
183
   *
   * @var string
   */
184
185
186
  protected $originalProfile;

  /**
187
   * The name of the session cookie of the test-runner.
188
189
190
191
   *
   * @var string
   */
  protected $originalSessionName;
192

193
194
  /**
   * The settings array.
195
196
   *
   * @var array
197
198
199
   */
  protected $originalSettings;

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
  /**
   * The original array of shutdown function callbacks.
   *
   * @var array
   */
  protected $originalShutdownCallbacks;

  /**
   * The site directory of the original parent site.
   *
   * @var string
   */
  protected $originalSite;

  /**
   * The original user, before testing began.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $originalUser;

221
222
223
224
225
226
227
  /**
   * The public file directory for the test environment.
   *
   * This is set in TestBase::prepareEnvironment().
   *
   * @var string
   */
228
  protected $publicFilesDirectory;
229

230
231
232
233
234
235
236
  /**
   * The private file directory for the test environment.
   *
   * This is set in TestBase::prepareEnvironment().
   *
   * @var string
   */
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
  protected $privateFilesDirectory;

  /**
   * The temporary file directory for the test environment.
   *
   * This is set in TestBase::prepareEnvironment().
   *
   * @var string
   */
  protected $tempFilesDirectory;

  /**
   * The translation file directory for the test environment.
   *
   * This is set in TestBase::prepareEnvironment().
   *
   * @var string
   */
  protected $translationFilesDirectory;
256

257
  /**
258
259
   * Whether to die in case any test assertion fails.
   *
260
   * @var bool
261
262
   *
   * @see run-tests.sh
263
   */
264
  public $dieOnFail = FALSE;
265

266
267
268
269
270
271
272
  /**
   * The DrupalKernel instance used in the test.
   *
   * @var \Drupal\Core\DrupalKernel
   */
  protected $kernel;

273
274
275
276
277
278
279
  /**
   * The dependency injection container used in the test.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

280
281
282
283
284
285
286
  /**
   * The config importer that can used in a test.
   *
   * @var \Drupal\Core\Config\ConfigImporter
   */
  protected $configImporter;

287
288
289
290
291
292
293
  /**
   * Set to TRUE to strict check all configuration saved.
   *
   * @see \Drupal\Core\Config\Testing\ConfigSchemaChecker
   *
   * @var bool
   */
294
  protected $strictConfigSchema = TRUE;
295

296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
  /**
   * HTTP authentication method (specified as a CURLAUTH_* constant).
   *
   * @var int
   * @see http://php.net/manual/en/function.curl-setopt.php
   */
  protected $httpAuthMethod = CURLAUTH_BASIC;

  /**
   * HTTP authentication credentials (<username>:<password>).
   *
   * @var string
   */
  protected $httpAuthCredentials = NULL;

311
312
313
314
315
316
317
318
319
320
  /**
   * Constructor for Test.
   *
   * @param $test_id
   *   Tests with the same id are reported together.
   */
  public function __construct($test_id = NULL) {
    $this->testId = $test_id;
  }

321
322
323
324
325
  /**
   * Performs setup tasks before each individual test method is run.
   */
  abstract protected function setUp();

326
327
328
329
330
331
332
333
334
335
  /**
   * Checks the matching requirements for Test.
   *
   * @return
   *   Array of errors containing a list of unmet requirements.
   */
  protected function checkRequirements() {
    return array();
  }

336
337
338
339
340
341
342
343
344
  /**
   * Helper method to store an assertion record in the configured database.
   *
   * This method decouples database access from assertion logic.
   *
   * @param array $assertion
   *   Keyed array representing an assertion, as generated by assert().
   *
   * @see self::assert()
345
346
347
   *
   * @return \Drupal\Core\Database\StatementInterface|int|null
   *   The message ID.
348
349
350
   */
  protected function storeAssertion(array $assertion) {
    return self::getDatabaseConnection()
351
      ->insert('simpletest', ['return' => Database::RETURN_INSERT_ID])
352
353
354
355
      ->fields($assertion)
      ->execute();
  }

356
357
358
359
  /**
   * Internal helper: stores the assert.
   *
   * @param $status
360
   *   Can be 'pass', 'fail', 'exception', 'debug'.
361
362
   *   TRUE is a synonym for 'pass', FALSE for 'fail'.
   * @param $message
363
   *   (optional) A message to display with the assertion. Do not translate
364
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
365
366
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
367
   * @param $group
368
369
370
371
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
   * @param $caller
   *   By default, the assert comes from a function whose name starts with
   *   'test'. Instead, you can specify where this assert originates from
   *   by passing in an associative array as $caller. Key 'file' is
   *   the name of the source file, 'line' is the line number and 'function'
   *   is the caller function itself.
   */
  protected function assert($status, $message = '', $group = 'Other', array $caller = NULL) {
    // Convert boolean status to string status.
    if (is_bool($status)) {
      $status = $status ? 'pass' : 'fail';
    }

    // Increment summary result counter.
    $this->results['#' . $status]++;

    // Get the function information about the call to the assertion method.
    if (!$caller) {
      $caller = $this->getAssertionCall();
    }

    // Creation assertion array that can be displayed while tests are running.
394
    $assertion = array(
395
396
397
398
399
400
401
402
403
404
405
      'test_id' => $this->testId,
      'test_class' => get_class($this),
      'status' => $status,
      'message' => $message,
      'message_group' => $group,
      'function' => $caller['function'],
      'line' => $caller['line'],
      'file' => $caller['file'],
    );

    // Store assertion for display after the test has completed.
406
407
408
    $message_id = $this->storeAssertion($assertion);
    $assertion['message_id'] = $message_id;
    $this->assertions[] = $assertion;
409
410
411
412
413
414
415

    // We do not use a ternary operator here to allow a breakpoint on
    // test failure.
    if ($status == 'pass') {
      return TRUE;
    }
    else {
416
      if ($this->dieOnFail && ($status == 'fail' || $status == 'exception')) {
417
418
        exit(1);
      }
419
420
421
422
423
424
425
426
427
428
429
      return FALSE;
    }
  }

  /**
   * Store an assertion from outside the testing context.
   *
   * This is useful for inserting assertions that can only be recorded after
   * the test case has been destroyed, such as PHP fatal errors. The caller
   * information is not automatically gathered since the caller is most likely
   * inserting the assertion on behalf of other code. In all other respects
430
   * the method behaves just like \Drupal\simpletest\TestBase::assert() in terms
431
432
433
434
435
   * of storing the assertion.
   *
   * @return
   *   Message ID of the stored assertion.
   *
436
437
   * @see \Drupal\simpletest\TestBase::assert()
   * @see \Drupal\simpletest\TestBase::deleteAssert()
438
439
440
441
442
443
444
445
   */
  public static function insertAssert($test_id, $test_class, $status, $message = '', $group = 'Other', array $caller = array()) {
    // Convert boolean status to string status.
    if (is_bool($status)) {
      $status = $status ? 'pass' : 'fail';
    }

    $caller += array(
446
      'function' => 'Unknown',
447
      'line' => 0,
448
      'file' => 'Unknown',
449
450
451
452
453
454
455
456
457
458
459
460
461
    );

    $assertion = array(
      'test_id' => $test_id,
      'test_class' => $test_class,
      'status' => $status,
      'message' => $message,
      'message_group' => $group,
      'function' => $caller['function'],
      'line' => $caller['line'],
      'file' => $caller['file'],
    );

462
    // We can't use storeAssertion() because this method is static.
463
464
    return self::getDatabaseConnection()
      ->insert('simpletest')
465
466
467
468
469
470
471
472
473
      ->fields($assertion)
      ->execute();
  }

  /**
   * Delete an assertion record by message ID.
   *
   * @param $message_id
   *   Message ID of the assertion to delete.
474
   *
475
476
477
   * @return
   *   TRUE if the assertion was deleted, FALSE otherwise.
   *
478
   * @see \Drupal\simpletest\TestBase::insertAssert()
479
480
   */
  public static function deleteAssert($message_id) {
481
    // We can't use storeAssertion() because this method is static.
482
483
    return (bool) self::getDatabaseConnection()
      ->delete('simpletest')
484
485
486
487
      ->condition('message_id', $message_id)
      ->execute();
  }

488
489
490
  /**
   * Returns the database connection to the site running Simpletest.
   *
491
   * @return \Drupal\Core\Database\Connection
492
493
494
   *   The database connection to use for inserting assertions.
   */
  public static function getDatabaseConnection() {
495
496
497
    // Check whether there is a test runner connection.
    // @see run-tests.sh
    // @todo Convert Simpletest UI runner to create + use this connection, too.
498
    try {
499
      $connection = Database::getConnection('default', 'test-runner');
500
501
    }
    catch (ConnectionNotDefinedException $e) {
502
503
504
505
506
507
508
509
510
511
512
      // Check whether there is a backup of the original default connection.
      // @see TestBase::prepareEnvironment()
      try {
        $connection = Database::getConnection('default', 'simpletest_original_default');
      }
      catch (ConnectionNotDefinedException $e) {
        // If TestBase::prepareEnvironment() or TestBase::restoreEnvironment()
        // failed, the test-specific database connection does not exist
        // yet/anymore, so fall back to the default of the (UI) test runner.
        $connection = Database::getConnection('default', 'default');
      }
513
514
515
516
    }
    return $connection;
  }

517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
  /**
   * Cycles through backtrace until the first non-assertion method is found.
   *
   * @return
   *   Array representing the true caller.
   */
  protected function getAssertionCall() {
    $backtrace = debug_backtrace();

    // The first element is the call. The second element is the caller.
    // We skip calls that occurred in one of the methods of our base classes
    // or in an assertion function.
   while (($caller = $backtrace[1]) &&
         ((isset($caller['class']) && isset($this->skipClasses[$caller['class']])) ||
           substr($caller['function'], 0, 6) == 'assert')) {
      // We remove that call.
      array_shift($backtrace);
    }

536
    return Error::getLastCaller($backtrace);
537
538
539
  }

  /**
540
541
542
   * Check to see if a value is not false.
   *
   * False values are: empty string, 0, NULL, and FALSE.
543
544
545
546
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
547
   *   (optional) A message to display with the assertion. Do not translate
548
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
549
550
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
551
   * @param $group
552
553
554
555
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
556
   *
557
558
559
560
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertTrue($value, $message = '', $group = 'Other') {
561
    return $this->assert((bool) $value, $message ? $message : SafeMarkup::format('Value @value is TRUE.', array('@value' => var_export($value, TRUE))), $group);
562
563
564
  }

  /**
565
566
567
   * Check to see if a value is false.
   *
   * False values are: empty string, 0, NULL, and FALSE.
568
569
570
571
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
572
   *   (optional) A message to display with the assertion. Do not translate
573
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
574
575
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
576
   * @param $group
577
578
579
580
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
581
   *
582
583
584
585
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertFalse($value, $message = '', $group = 'Other') {
586
    return $this->assert(!$value, $message ? $message : SafeMarkup::format('Value @value is FALSE.', array('@value' => var_export($value, TRUE))), $group);
587
588
589
590
591
592
593
594
  }

  /**
   * Check to see if a value is NULL.
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
595
   *   (optional) A message to display with the assertion. Do not translate
596
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
597
598
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
599
   * @param $group
600
601
602
603
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
604
   *
605
606
607
608
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNull($value, $message = '', $group = 'Other') {
609
    return $this->assert(!isset($value), $message ? $message : SafeMarkup::format('Value @value is NULL.', array('@value' => var_export($value, TRUE))), $group);
610
611
612
613
614
615
616
617
  }

  /**
   * Check to see if a value is not NULL.
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
618
   *   (optional) A message to display with the assertion. Do not translate
619
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
620
621
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
622
   * @param $group
623
624
625
626
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
627
   *
628
629
630
631
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNotNull($value, $message = '', $group = 'Other') {
632
    return $this->assert(isset($value), $message ? $message : SafeMarkup::format('Value @value is not NULL.', array('@value' => var_export($value, TRUE))), $group);
633
634
635
636
637
638
639
640
641
642
  }

  /**
   * Check to see if two values are equal.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
643
   *   (optional) A message to display with the assertion. Do not translate
644
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
645
646
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
647
   * @param $group
648
649
650
651
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
652
   *
653
654
655
656
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertEqual($first, $second, $message = '', $group = 'Other') {
657
    return $this->assert($first == $second, $message ? $message : SafeMarkup::format('Value @first is equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
658
659
660
661
662
663
664
665
666
667
  }

  /**
   * Check to see if two values are not equal.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
668
   *   (optional) A message to display with the assertion. Do not translate
669
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
670
671
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
672
   * @param $group
673
674
675
676
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
677
   *
678
679
680
681
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNotEqual($first, $second, $message = '', $group = 'Other') {
682
    return $this->assert($first != $second, $message ? $message : SafeMarkup::format('Value @first is not equal to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
683
684
685
686
687
688
689
690
691
692
  }

  /**
   * Check to see if two values are identical.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
693
   *   (optional) A message to display with the assertion. Do not translate
694
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
695
696
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
697
   * @param $group
698
699
700
701
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
702
   *
703
704
705
706
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertIdentical($first, $second, $message = '', $group = 'Other') {
707
    return $this->assert($first === $second, $message ? $message : SafeMarkup::format('Value @first is identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
708
709
710
711
712
713
714
715
716
717
  }

  /**
   * Check to see if two values are not identical.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
718
   *   (optional) A message to display with the assertion. Do not translate
719
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
720
721
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
722
   * @param $group
723
724
725
726
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
727
   *
728
729
730
731
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
  protected function assertNotIdentical($first, $second, $message = '', $group = 'Other') {
732
    return $this->assert($first !== $second, $message ? $message : SafeMarkup::format('Value @first is not identical to value @second.', array('@first' => var_export($first, TRUE), '@second' => var_export($second, TRUE))), $group);
733
734
  }

735
736
737
738
739
740
741
742
  /**
   * Checks to see if two objects are identical.
   *
   * @param object $object1
   *   The first object to check.
   * @param object $object2
   *   The second object to check.
   * @param $message
743
   *   (optional) A message to display with the assertion. Do not translate
744
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
745
746
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
747
   * @param $group
748
749
750
751
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
752
753
754
755
   *
   * @return
   *   TRUE if the assertion succeeded, FALSE otherwise.
   */
756
  protected function assertIdenticalObject($object1, $object2, $message = '', $group = 'Other') {
757
    $message = $message ?: SafeMarkup::format('!object1 is identical to !object2', array(
758
759
760
761
762
763
764
      '!object1' => var_export($object1, TRUE),
      '!object2' => var_export($object2, TRUE),
    ));
    $identical = TRUE;
    foreach ($object1 as $key => $value) {
      $identical = $identical && isset($object2->$key) && $object2->$key === $value;
    }
765
    return $this->assertTrue($identical, $message, $group);
766
767
  }

768
769
770
771
772
773
774
  /**
   * Asserts that no errors have been logged to the PHP error.log thus far.
   *
   * @return bool
   *   TRUE if the assertion succeeded, FALSE otherwise.
   *
   * @see TestBase::prepareEnvironment()
775
   * @see \Drupal\Core\DrupalKernel::bootConfiguration()
776
777
778
779
780
781
   */
  protected function assertNoErrorsLogged() {
    // Since PHP only creates the error.log file when an actual error is
    // triggered, it is sufficient to check whether the file exists.
    return $this->assertFalse(file_exists(DRUPAL_ROOT . '/' . $this->siteDirectory . '/error.log'), 'PHP error.log is empty.');
  }
782

783
784
785
786
  /**
   * Fire an assertion that is always positive.
   *
   * @param $message
787
   *   (optional) A message to display with the assertion. Do not translate
788
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
789
790
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
791
   * @param $group
792
793
794
795
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
796
   *
797
798
799
800
801
802
803
804
805
806
807
   * @return
   *   TRUE.
   */
  protected function pass($message = NULL, $group = 'Other') {
    return $this->assert(TRUE, $message, $group);
  }

  /**
   * Fire an assertion that is always negative.
   *
   * @param $message
808
   *   (optional) A message to display with the assertion. Do not translate
809
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
810
811
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
812
   * @param $group
813
814
815
816
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
817
   *
818
819
820
821
822
823
824
825
826
827
828
   * @return
   *   FALSE.
   */
  protected function fail($message = NULL, $group = 'Other') {
    return $this->assert(FALSE, $message, $group);
  }

  /**
   * Fire an error assertion.
   *
   * @param $message
829
   *   (optional) A message to display with the assertion. Do not translate
830
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
831
832
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
833
   * @param $group
834
835
836
837
   *   (optional) The group this message is in, which is displayed in a column
   *   in test output. Use 'Debug' to indicate this is debugging output. Do not
   *   translate this string. Defaults to 'Other'; most tests do not override
   *   this default.
838
839
   * @param $caller
   *   The caller of the error.
840
   *
841
842
843
844
845
846
847
848
849
850
851
852
853
854
   * @return
   *   FALSE.
   */
  protected function error($message = '', $group = 'Other', array $caller = NULL) {
    if ($group == 'User notice') {
      // Since 'User notice' is set by trigger_error() which is used for debug
      // set the message to a status of 'debug'.
      return $this->assert('debug', $message, 'Debug', $caller);
    }

    return $this->assert('exception', $message, $group, $caller);
  }

  /**
855
   * Logs a verbose message in a text file.
856
   *
857
858
   * The link to the verbose message will be placed in the test results as a
   * passing assertion with the text '[verbose message]'.
859
860
861
862
863
864
865
   *
   * @param $message
   *   The verbose message to be stored.
   *
   * @see simpletest_verbose()
   */
  protected function verbose($message) {
866
867
868
869
870
    // Do nothing if verbose debugging is disabled.
    if (!$this->verbose) {
      return;
    }

871
872
873
874
    $message = '<hr />ID #' . $this->verboseId . ' (<a href="' . $this->verboseClassName . '-' . ($this->verboseId - 1) . '-' . $this->testId . '.html">Previous</a> | <a href="' . $this->verboseClassName . '-' . ($this->verboseId + 1) . '-' . $this->testId . '.html">Next</a>)<hr />' . $message;
    $verbose_filename =  $this->verboseClassName . '-' . $this->verboseId . '-' . $this->testId . '.html';
    if (file_put_contents($this->verboseDirectory . '/' . $verbose_filename, $message)) {
      $url = $this->verboseDirectoryUrl . '/' . $verbose_filename;
875
      // Not using _l() to avoid invoking the theme system, so that unit tests
876
      // can use verbose() as well.
877
      $url = '<a href="' . $url . '" target="_blank">Verbose message</a>';
878
      $this->error($url, 'User notice');
879
    }
880
    $this->verboseId++;
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
  }

  /**
   * Run all tests in this class.
   *
   * Regardless of whether $methods are passed or not, only method names
   * starting with "test" are executed.
   *
   * @param $methods
   *   (optional) A list of method names in the test case class to run; e.g.,
   *   array('testFoo', 'testBar'). By default, all methods of the class are
   *   taken into account, but it can be useful to only run a few selected test
   *   methods during debugging.
   */
  public function run(array $methods = array()) {
896
897
898
899
900
901
902
903
904
905
906
907
908
    $class = get_class($this);

    if ($missing_requirements = $this->checkRequirements()) {
      $object_info = new \ReflectionObject($this);
      $caller = array(
        'file' => $object_info->getFileName(),
      );
      foreach ($missing_requirements as $missing_requirement) {
        TestBase::insertAssert($this->testId, $class, FALSE, $missing_requirement, 'Requirements check', $caller);
      }
      return;
    }

909
    TestServiceProvider::$currentTest = $this;
910
    $simpletest_config = $this->config('simpletest.settings');
911

912
913
914
915
    // Unless preset from run-tests.sh, retrieve the current verbose setting.
    if (!isset($this->verbose)) {
      $this->verbose = $simpletest_config->get('verbose');
    }
916

917
    if ($this->verbose) {
918
919
      // Initialize verbose debugging.
      $this->verbose = TRUE;
920
      $this->verboseDirectory = PublicStream::basePath() . '/simpletest/verbose';
921
      $this->verboseDirectoryUrl = file_create_url($this->verboseDirectory);
922
923
924
925
926
      if (file_prepare_directory($this->verboseDirectory, FILE_CREATE_DIRECTORY) && !file_exists($this->verboseDirectory . '/.htaccess')) {
        file_put_contents($this->verboseDirectory . '/.htaccess', "<IfModule mod_expires.c>\nExpiresActive Off\n</IfModule>\n");
      }
      $this->verboseClassName = str_replace("\\", "_", $class);
    }
927
928
    // HTTP auth settings (<username>:<password>) for the simpletest browser
    // when sending requests to the test site.
929
    $this->httpAuthMethod = (int) $simpletest_config->get('httpauth.method');
930
931
932
    $username = $simpletest_config->get('httpauth.username');
    $password = $simpletest_config->get('httpauth.password');
    if (!empty($username) && !empty($password)) {
933
      $this->httpAuthCredentials = $username . ':' . $password;
934
935
936
937
938
    }

    set_error_handler(array($this, 'errorHandler'));
    // Iterate through all the methods in this class, unless a specific list of
    // methods to run was passed.
939
940
941
    $test_methods = array_filter(get_class_methods($class), function ($method) {
      return strpos($method, 'test') === 0;
    });
942
943
944
945
946
    if (empty($test_methods)) {
      // Call $this->assert() here because we need to pass along custom caller
      // information, lest the wrong originating code file/line be identified.
      $this->assert(FALSE, 'No test methods found.', 'Requirements', array('function' => __METHOD__ . '()', 'file' => __FILE__, 'line' => __LINE__));
    }
947
    if ($methods) {
948
949
950
951
952
953
      $test_methods = array_intersect($test_methods, $methods);
    }
    foreach ($test_methods as $method) {
      // Insert a fail record. This will be deleted on completion to ensure
      // that testing completed.
      $method_info = new \ReflectionMethod($class, $method);
954
      $caller = array(
955
956
957
        'file' => $method_info->getFileName(),
        'line' => $method_info->getStartLine(),
        'function' => $class . '->' . $method . '()',
958
      );
959
960
961
962
      $test_completion_check_id = TestBase::insertAssert($this->testId, $class, FALSE, 'The test did not complete due to a fatal error.', 'Completion check', $caller);

      try {
        $this->prepareEnvironment();
963
      }
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
      catch (\Exception $e) {
        $this->exceptionHandler($e);
        // The prepareEnvironment() method isolates the test from the parent
        // Drupal site by creating a random database prefix and test site
        // directory. If this fails, a test would possibly operate in the
        // parent site. Therefore, the entire test run for this test class
        // has to be aborted.
        // restoreEnvironment() cannot be called, because we do not know
        // where exactly the environment setup failed.
        break;
      }

      try {
        $this->setUp();
      }
      catch (\Exception $e) {
        $this->exceptionHandler($e);
        // Abort if setUp() fails, since all test methods will fail.
        // But ensure to clean up and restore the environment, since
        // prepareEnvironment() succeeded.
        $this->restoreEnvironment();
        break;
986
      }
987
988
      try {
        $this->$method();
989
      }
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
      catch (\Exception $e) {
        $this->exceptionHandler($e);
      }
      try {
        $this->tearDown();
      }
      catch (\Exception $e) {
        $this->exceptionHandler($e);
        // If a test fails to tear down, abort the entire test class, since
        // it is likely that all tests will fail in the same way and a
        // failure here only results in additional test artifacts that have
        // to be manually deleted.
        $this->restoreEnvironment();
        break;
      }

      $this->restoreEnvironment();
      // Remove the test method completion check record.
      TestBase::deleteAssert($test_completion_check_id);
1009
    }
1010

1011
    TestServiceProvider::$currentTest = NULL;
1012
1013
1014
1015
1016
    // Clear out the error messages and restore error handler.
    drupal_get_messages();
    restore_error_handler();
  }

1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
  /**
   * Generates a database prefix for running tests.
   *
   * The database prefix is used by prepareEnvironment() to setup a public files
   * directory for the test to be run, which also contains the PHP error log,
   * which is written to in case of a fatal error. Since that directory is based
   * on the database prefix, all tests (even unit tests) need to have one, in
   * order to access and read the error log.
   *
   * @see TestBase::prepareEnvironment()
   *
   * The generated database table prefix is used for the Drupal installation
   * being performed for the test. It is also used as user agent HTTP header
1030
1031
1032
1033
   * value by the cURL-based browser of WebTestBase, which is sent to the Drupal
   * installation of the test. During early Drupal bootstrap, the user agent
   * HTTP header is parsed, and if it matches, all database queries use the
   * database table prefix that has been generated here.
1034
1035
1036
1037
   *
   * @see WebTestBase::curlInitialize()
   * @see drupal_valid_test_ua()
   */
1038
  private function prepareDatabasePrefix() {
1039
1040
1041
1042
1043
1044
1045
1046
    // Ensure that the generated test site directory does not exist already,
    // which may happen with a large amount of concurrent threads and
    // long-running tests.
    do {
      $suffix = mt_rand(100000, 999999);
      $this->siteDirectory = 'sites/simpletest/' . $suffix;
      $this->databasePrefix = 'simpletest' . $suffix;
    } while (is_dir(DRUPAL_ROOT . '/' . $this->siteDirectory));
1047
1048
1049
1050

    // As soon as the database prefix is set, the test might start to execute.
    // All assertions as well as the SimpleTest batch operations are associated
    // with the testId, so the database prefix has to be associated with it.
1051
    $affected_rows = self::getDatabaseConnection()->update('simpletest_test_id')
1052
1053
1054
      ->fields(array('last_prefix' => $this->databasePrefix))
      ->condition('test_id', $this->testId)
      ->execute();
1055
1056
1057
    if (!$affected_rows) {
      throw new \RuntimeException('Failed to set up database prefix.');
    }
1058
1059
1060
1061
1062
  }

  /**
   * Changes the database connection to the prefixed one.
   *
1063
   * @see TestBase::prepareEnvironment()
1064
   */
1065
  private function changeDatabasePrefix() {
1066
1067
1068
    if (empty($this->databasePrefix)) {
      $this->prepareDatabasePrefix();
    }
1069
1070
1071
1072
1073
1074
1075
    // If the backup already exists, something went terribly wrong.
    // This case is possible, because database connection info is a static
    // global state construct on the Database class, which at least persists
    // for all test methods executed in one PHP process.
    if (Database::getConnectionInfo('simpletest_original_default')) {
      throw new \RuntimeException("Bad Database connection state: 'simpletest_original_default' connection key already exists. Broken test?");
    }
1076
1077
1078
1079
1080

    // Clone the current connection and replace the current prefix.
    $connection_info = Database::getConnectionInfo('default');
    Database::renameConnection('default', 'simpletest_original_default');
    foreach ($connection_info as $target => $value) {
1081
1082
1083
1084
1085
      // Replace the full table prefix definition to ensure that no table
      // prefixes of the test runner leak into the test.
      $connection_info[$target]['prefix'] = array(
        'default' => $value['prefix']['default'] . $this->databasePrefix,
      );
1086
1087
    }
    Database::addConnectionInfo('default', 'default', $connection_info['default']);
1088
  }
1089

1090
1091
1092
  /**
   * Act on global state information before the environment is altered for a test.
   *
1093
   * Allows e.g. KernelTestBase to prime system/extension info from the
1094
1095
1096
1097
   * parent site (and inject it into the test environment so as to improve
   * performance).
   */
  protected function beforePrepareEnvironment() {
1098
1099
1100
1101
1102
1103
1104
  }

  /**
   * Prepares the current environment for running the test.
   *
   * Backups various current environment variables and resets them, so they do
   * not interfere with the Drupal site installation in which tests are executed
1105
   * and can be restored in TestBase::restoreEnvironment().
1106
1107
1108
1109
   *
   * Also sets up new resources for the testing environment, such as the public
   * filesystem and configuration directories.
   *
1110
1111
1112
1113
1114
   * This method is private as it must only be called once by TestBase::run()
   * (multiple invocations for the same test would have unpredictable
   * consequences) and it must not be callable or overridable by test classes.
   *
   * @see TestBase::beforePrepareEnvironment()
1115
   */
1116
  private function prepareEnvironment() {
1117
    $user = \Drupal::currentUser();
1118
1119
1120
1121
1122
1123
    // Allow (base) test classes to backup global state information.
    $this->beforePrepareEnvironment();

    // Create the database prefix for this test.
    $this->prepareDatabasePrefix();

1124
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
1125

1126
    // When running the test runner within a test, back up the original database
1127
1128
    // prefix.
    if (DRUPAL_TEST_IN_CHILD_SITE) {
1129
1130
1131
      $this->originalPrefix = drupal_valid_test_ua();
    }

1132
    // Backup current in-memory configuration.
1133
1134
    $site_path = \Drupal::service('site.path');
    $this->originalSite = $site_path;
1135
    $this->originalSettings = Settings::getAll();
1136
    $this->originalConfig = $GLOBALS['config'];
1137
    // @todo Remove all remnants of $GLOBALS['conf'].
1138
    // @see https://www.drupal.org/node/2183323
1139
    $this->originalConf = isset($GLOBALS['conf']) ? $GLOBALS['conf'] : NULL;
1140
1141

    // Backup statics and globals.
1142
    $this->originalContainer = clone \Drupal::getContainer();
1143
    $this->originalLanguage = $language_interface;
1144
    $this->originalConfigDirectories = $GLOBALS['config_directories'];
1145
1146

    // Save further contextual information.
1147
1148
    // Use the original files directory to avoid nesting it within an existing
    // simpletest directory if a test is executed within a test.
1149
    $this->originalFileDirectory = Settings::get('file_public_path', $site_path . '/files');
1150
    $this->originalProfile = drupal_get_profile();
1151
    $this->originalUser = isset($user) ? clone $user : NULL;
1152

1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
    // Prevent that session data is leaked into the UI test runner by closing
    // the session and then setting the session-name (i.e. the name of the
    // session cookie) to a random value. If a test starts a new session, then
    // it will be associated with a different session-name. After the test-run
    // it can be safely destroyed.
    // @see TestBase::restoreEnvironment()
    if (PHP_SAPI !== 'cli' && session_status() === PHP_SESSION_ACTIVE) {
      session_write_close();
    }
    $this->originalSessionName = session_name();
    session_name('SIMPLETEST' . Crypt::randomBytesBase64());
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174

    // Save and clean the shutdown callbacks array because it is static cached
    // and will be changed by the test run. Otherwise it will contain callbacks
    // from both environments and the testing environment will try to call the
    // handlers defined by the original one.
    $callbacks = &drupal_register_shutdown_function();
    $this->originalShutdownCallbacks = $callbacks;
    $callbacks = array();

    // Create test directory ahead of installation so fatal errors and debug
    // information can be logged during installation process.
1175
1176
1177
    file_prepare_directory($this->siteDirectory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);

    // Prepare filesystem directory paths.
1178
1179
1180
1181
    $this->publicFilesDirectory = $this->siteDirectory . '/files';
    $this->privateFilesDirectory = $this->siteDirectory . '/private';
    $this->tempFilesDirectory = $this->siteDirectory . '/temp';
    $this->translationFilesDirectory = $this->siteDirectory . '/translations';
1182

1183
    $this->generatedTestFiles = FALSE;
1184

1185
1186
1187
    // Ensure the configImporter is refreshed for each test.
    $this->configImporter = NULL;

1188
1189
    // Unregister all custom stream wrappers of the parent site.
    // Availability of Drupal stream wrappers varies by test base class:
1190
    // - KernelTestBase supports and maintains stream wrappers in a custom
1191
1192
1193
    //   way.
    // - WebTestBase re-initializes Drupal stream wrappers after installation.
    // The original stream wrappers are restored after the test run.
1194
    // @see TestBase::restoreEnvironment()
1195
    $this->originalContainer->get('stream_wrapper_manager')->unregister();
1196

1197
    // Reset statics.
1198
1199
    drupal_static_reset();

1200
1201
    // Ensure there is no service container.
    $this->container = NULL;
1202
    \Drupal::unsetContainer();
1203

1204
    // Unset globals.
1205
    unset($GLOBALS['config_directories']);
1206
1207
    unset($GLOBALS['config']);
    unset($GLOBALS['conf']);
1208

1209
1210
    // Log fatal errors.
    ini_set('log_errors', 1);
1211
    ini_set('error_log', DRUPAL_ROOT . '/' . $this->siteDirectory . '/error.log');
1212

1213
1214
1215
    // Change the database prefix.
    $this->changeDatabasePrefix();

1216
1217
1218
    // After preparing the environment and changing the database prefix, we are
    // in a valid test environment.
    drupal_valid_test_ua($this->databasePrefix);
1219

1220
1221
1222
1223
    // Reset settings.
    new Settings(array(
      // For performance, simply use the database prefix as hash salt.
      'hash_salt' => $this->databasePrefix,
1224
      'container_yamls' => [],
1225
1226
    ));

1227
    drupal_set_time_limit($this->timeLimit);
1228
1229
  }

1230
  /**
1231
   * Performs cleanup tasks after each individual test method has been run.
1232
1233
1234
1235
1236
1237
   */
  protected function tearDown() {
  }

  /**
   * Cleans up the test environment and restores the original environment.
1238
   *
1239
   * Deletes created files, database tables, and reverts environment changes.
1240
1241
1242
1243
1244
1245
1246
   *
   * This method needs to be invoked for both unit and integration tests.
   *
   * @see TestBase::prepareDatabasePrefix()
   * @see TestBase::changeDatabasePrefix()
   * @see TestBase::prepareEnvironment()
   */
1247
  private function restoreEnvironment() {
1248
1249
1250
1251
1252
1253
1254
1255
1256
    // Destroy the session if one was started during the test-run.
    $_SESSION = array();
    if (PHP_SAPI !== 'cli' && session_status() === PHP_SESSION_ACTIVE) {
      session_destroy();
      $params = session_get_cookie_params();
      setcookie(session_name(), '', REQUEST_TIME - 3600, $params['path'], $params['domain'], $params['secure'], $params['httponly']);
    }
    session_name($this->originalSessionName);

1257
1258
1259
1260
1261
1262
1263
    // Reset all static variables.
    // Unsetting static variables will potentially invoke destruct methods,
    // which might call into functions that prime statics and caches again.
    // In that case, all functions are still operating on the test environment,
    // which means they may need to access its filesystem and database.
    drupal_static_reset();

1264
    if ($this->container && $this->container->has('state') && $state = $this->container->get('state')) {
1265
      $captured_emails = $state->get('system.test_mail_collector') ?: array();
1266
1267
      $emailCount = count($captured_emails);
      if ($emailCount) {
1268
1269
        $message = $emailCount == 1 ? '1 email was sent during this test.' : $emailCount . ' emails were sent during this test.';
        $this->pass($message, 'Email');
1270
1271
1272
      }
    }

1273
    // Sleep for 50ms to allow shutdown functions and terminate events to
1274
    // complete. Further information: https://www.drupal.org/node/2194357.
1275
1276
    usleep(50000);

1277
1278
    // Remove all prefixed tables.
    $original_connection_info = Database::getConnectionInfo('simpletest_original_default');
1279
    $original_prefix = $original_connection_info['default']['prefix']['default'];
1280
    $test_connection_info = Database::getConnectionInfo('default');
1281
    $test_prefix = $test_connection_info['default']['prefix']['default'];
1282
    if ($original_prefix != $test_prefix) {