function UpdateMailTest::testUpdateEmail

Same name and namespace in other branches
  1. 11.x core/modules/update/tests/src/Unit/UpdateMailTest.php \Drupal\Tests\update\Unit\UpdateMailTest::testUpdateEmail()

Test the subject and body of update text.

@dataProvider providerTestUpdateEmail

File

core/modules/update/tests/src/Unit/UpdateMailTest.php, line 79

Class

UpdateMailTest
Tests text of update email.

Namespace

Drupal\Tests\update\Unit

Code

public function testUpdateEmail($notification_threshold, $params, $authorized, array $expected_body) : void {
  $langcode = 'en';
  $available_updates_url = 'https://example.com/admin/reports/updates';
  $update_settings_url = 'https://example.com/admin/reports/updates/settings';
  $site_name = 'Test site';
  // Initialize update_mail input parameters.
  $key = NULL;
  $message = [
    'langcode' => $langcode,
    'subject' => '',
    'message' => '',
    'body' => [],
  ];
  // Language manager just returns the language.
  $this->languageManager
    ->expects($this->once())
    ->method('getLanguage')
    ->willReturn($langcode);
  // Create three config entities.
  $config_site_name = $this->createMock('Drupal\\Core\\Config\\Config');
  $config_site_name->expects($this->once())
    ->method('get')
    ->with('name')
    ->willReturn($site_name);
  $config_notification = $this->createMock('Drupal\\Core\\Config\\Config');
  $config_notification->expects($this->once())
    ->method('get')
    ->with('notification.threshold')
    ->willReturn($notification_threshold);
  $this->configFactory
    ->expects($this->exactly(2))
    ->method('get')
    ->willReturnMap([
    [
      'system.site',
      $config_site_name,
    ],
    [
      'update.settings',
      $config_notification,
    ],
  ]);
  // The calls to generateFromRoute differ if authorized.
  $count = 2;
  if ($authorized) {
    $this->currentUser
      ->expects($this->once())
      ->method('hasPermission')
      ->with('administer software updates')
      ->willReturn(TRUE);
    $count = 3;
  }
  // When authorized also get the URL for the route 'update.report_update'.
  $this->urlGenerator
    ->expects($this->exactly($count))
    ->method('generateFromRoute')
    ->willReturnMap([
    [
      'update.status',
      [],
      [
        'absolute' => TRUE,
        'language' => $langcode,
      ],
      FALSE,
      $update_settings_url,
    ],
    [
      'update.settings',
      [],
      [
        'absolute' => TRUE,
      ],
      FALSE,
      $available_updates_url,
    ],
    [
      'update.report_update',
      [],
      [
        'absolute' => TRUE,
        'language' => $langcode,
      ],
      FALSE,
      $available_updates_url,
    ],
  ]);
  // Set the container.
  $this->container
    ->set('language_manager', $this->languageManager);
  $this->container
    ->set('url_generator', $this->urlGenerator);
  $this->container
    ->set('config.factory', $this->configFactory);
  $this->container
    ->set('current_user', $this->currentUser);
  \Drupal::setContainer($this->container);
  // Generate the email message.
  update_mail($key, $message, $params);
  // Confirm the subject.
  $this->assertSame("New release(s) available for {$site_name}", $message['subject']);
  // Confirm each part of the body.
  if ($authorized) {
    $this->assertSame($expected_body[0], $message['body'][0]);
    $this->assertSame($expected_body[1], $message['body'][1]);
    $this->assertSame($expected_body[2], $message['body'][2]->render());
  }
  else {
    if (empty($params)) {
      $this->assertSame($expected_body[0], $message['body'][0]);
      $this->assertSame($expected_body[1], $message['body'][1]->render());
    }
    else {
      $this->assertSame($expected_body[0], $message['body'][0]->render());
      $this->assertSame($expected_body[1], $message['body'][1]);
      $this->assertSame($expected_body[2], $message['body'][2]);
      $this->assertSame($expected_body[3], $message['body'][3]->render());
    }
  }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.