Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\user\Functional;
Chris@0: 
Chris@0: use Drupal\Core\Test\AssertMailTrait;
Chris@0: use Drupal\KernelTests\Core\Entity\EntityKernelTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests _user_mail_notify() use of user.settings.notify.*.
Chris@0:  *
Chris@0:  * @group user
Chris@0:  */
Chris@0: class UserMailNotifyTest extends EntityKernelTestBase {
Chris@0: 
Chris@0:   use AssertMailTrait {
Chris@0:     getMails as drupalGetMails;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Data provider for user mail testing.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    */
Chris@0:   public function userMailsProvider() {
Chris@0:     return [
Chris@0:       ['cancel_confirm', ['cancel_confirm']],
Chris@0:       ['password_reset', ['password_reset']],
Chris@0:       ['status_activated', ['status_activated']],
Chris@0:       ['status_blocked', ['status_blocked']],
Chris@0:       ['status_canceled', ['status_canceled']],
Chris@0:       ['register_admin_created', ['register_admin_created']],
Chris@0:       ['register_no_approval_required', ['register_no_approval_required']],
Chris@17:       ['register_pending_approval', ['register_pending_approval', 'register_pending_approval_admin']],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests mails are sent when notify.$op is TRUE.
Chris@0:    *
Chris@0:    * @param string $op
Chris@0:    *   The operation being performed on the account.
Chris@0:    * @param array $mail_keys
Chris@0:    *   The mail keys to test for.
Chris@0:    *
Chris@0:    * @dataProvider userMailsProvider
Chris@0:    */
Chris@0:   public function testUserMailsSent($op, array $mail_keys) {
Chris@0:     $this->config('user.settings')->set('notify.' . $op, TRUE)->save();
Chris@0:     $return = _user_mail_notify($op, $this->createUser());
Chris@0:     $this->assertTrue($return, '_user_mail_notify() returns TRUE.');
Chris@0:     foreach ($mail_keys as $key) {
Chris@0:       $filter = ['key' => $key];
Chris@0:       $this->assertNotEmpty($this->getMails($filter), "Mails with $key exists.");
Chris@0:     }
Chris@0:     $this->assertCount(count($mail_keys), $this->getMails(), 'The expected number of emails sent.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests mails are not sent when notify.$op is FALSE.
Chris@0:    *
Chris@0:    * @param string $op
Chris@0:    *   The operation being performed on the account.
Chris@0:    * @param array $mail_keys
Chris@0:    *   The mail keys to test for. Ignored by this test because we assert that no
Chris@0:    *   mails at all are sent.
Chris@0:    *
Chris@0:    * @dataProvider userMailsProvider
Chris@0:    */
Chris@0:   public function testUserMailsNotSent($op, array $mail_keys) {
Chris@0:     $this->config('user.settings')->set('notify.' . $op, FALSE)->save();
Chris@0:     $return = _user_mail_notify($op, $this->createUser());
Chris@0:     $this->assertFalse($return, '_user_mail_notify() returns FALSE.');
Chris@0:     $this->assertEmpty($this->getMails(), 'No emails sent by _user_mail_notify().');
Chris@0:   }
Chris@0: 
Chris@0: }