Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\system\Tests\System;
Chris@0: 
Chris@0: use Drupal\Core\Url;
Chris@0: use Drupal\simpletest\WebTestBase;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests access to site while in maintenance mode.
Chris@0:  *
Chris@0:  * @group system
Chris@0:  */
Chris@0: class SiteMaintenanceTest extends WebTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['node'];
Chris@0: 
Chris@0:   protected $adminUser;
Chris@0: 
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     // Configure 'node' as front page.
Chris@0:     $this->config('system.site')->set('page.front', '/node')->save();
Chris@0:     $this->config('system.performance')->set('js.preprocess', 1)->save();
Chris@0: 
Chris@0:     // Create a user allowed to access site in maintenance mode.
Chris@0:     $this->user = $this->drupalCreateUser(['access site in maintenance mode']);
Chris@0:     // Create an administrative user.
Chris@0:     $this->adminUser = $this->drupalCreateUser(['administer site configuration', 'access site in maintenance mode']);
Chris@0:     $this->drupalLogin($this->adminUser);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Verifies site maintenance mode functionality.
Chris@0:    */
Chris@0:   public function testSiteMaintenance() {
Chris@0: 
Chris@0:     // Verify that permission message is displayed.
Chris@0:     $permission_handler = $this->container->get('user.permissions');
Chris@0:     $permissions = $permission_handler->getPermissions();
Chris@0:     $permission_label = $permissions['access site in maintenance mode']['title'];
Chris@0:     $permission_message = t('Visitors will only see the maintenance mode message. Only users with the "@permission-label" <a href=":permissions-url">permission</a> will be able to access the site. Authorized users can log in directly via the <a href=":user-login">user login</a> page.', ['@permission-label' => $permission_label, ':permissions-url' => \Drupal::url('user.admin_permissions'), ':user-login' => \Drupal::url('user.login')]);
Chris@0:     $this->drupalGet(Url::fromRoute('system.site_maintenance_mode'));
Chris@0:     $this->assertRaw($permission_message, 'Found the permission message.');
Chris@0: 
Chris@0:     $this->drupalGet(Url::fromRoute('user.page'));
Chris@0:     // JS should be aggregated, so drupal.js is not in the page source.
Chris@0:     $links = $this->xpath('//script[contains(@src, :href)]', [':href' => '/core/misc/drupal.js']);
Chris@0:     $this->assertFalse(isset($links[0]), 'script /core/misc/drupal.js not in page');
Chris@0:     // Turn on maintenance mode.
Chris@0:     $edit = [
Chris@0:       'maintenance_mode' => 1,
Chris@0:     ];
Chris@0:     $this->drupalPostForm('admin/config/development/maintenance', $edit, t('Save configuration'));
Chris@0: 
Chris@0:     $admin_message = t('Operating in maintenance mode. <a href=":url">Go online.</a>', [':url' => \Drupal::url('system.site_maintenance_mode')]);
Chris@0:     $user_message = t('Operating in maintenance mode.');
Chris@0:     $offline_message = t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', ['@site' => $this->config('system.site')->get('name')]);
Chris@0: 
Chris@0:     $this->drupalGet(Url::fromRoute('user.page'));
Chris@0:     // JS should not be aggregated, so drupal.js is expected in the page source.
Chris@0:     $links = $this->xpath('//script[contains(@src, :href)]', [':href' => '/core/misc/drupal.js']);
Chris@0:     $this->assertTrue(isset($links[0]), 'script /core/misc/drupal.js in page');
Chris@0:     $this->assertRaw($admin_message, 'Found the site maintenance mode message.');
Chris@0: 
Chris@0:     // Logout and verify that offline message is displayed.
Chris@0:     $this->drupalLogout();
Chris@0:     $this->drupalGet('');
Chris@0:     $this->assertEqual('Site under maintenance', $this->cssSelect('main h1')[0]);
Chris@0:     $this->assertText($offline_message);
Chris@0:     $this->drupalGet('node');
Chris@0:     $this->assertEqual('Site under maintenance', $this->cssSelect('main h1')[0]);
Chris@0:     $this->assertText($offline_message);
Chris@0:     $this->drupalGet('user/register');
Chris@0:     $this->assertEqual('Site under maintenance', $this->cssSelect('main h1')[0]);
Chris@0:     $this->assertText($offline_message);
Chris@0: 
Chris@0:     // Verify that user is able to log in.
Chris@0:     $this->drupalGet('user');
Chris@0:     $this->assertNoText($offline_message);
Chris@0:     $this->drupalGet('user/login');
Chris@0:     $this->assertNoText($offline_message);
Chris@0: 
Chris@0:     // Log in user and verify that maintenance mode message is displayed
Chris@0:     // directly after login.
Chris@0:     $edit = [
Chris@0:       'name' => $this->user->getUsername(),
Chris@0:       'pass' => $this->user->pass_raw,
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Log in'));
Chris@0:     $this->assertText($user_message);
Chris@0: 
Chris@0:     // Log in administrative user and configure a custom site offline message.
Chris@0:     $this->drupalLogout();
Chris@0:     $this->drupalLogin($this->adminUser);
Chris@0:     $this->drupalGet('admin/config/development/maintenance');
Chris@0:     $this->assertNoRaw($admin_message, 'Site maintenance mode message not displayed.');
Chris@0: 
Chris@0:     $offline_message = 'Sorry, not online.';
Chris@0:     $edit = [
Chris@0:       'maintenance_mode_message' => $offline_message,
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save configuration'));
Chris@0: 
Chris@0:     // Logout and verify that custom site offline message is displayed.
Chris@0:     $this->drupalLogout();
Chris@0:     $this->drupalGet('');
Chris@0:     $this->assertEqual('Site under maintenance', $this->cssSelect('main h1')[0]);
Chris@0:     $this->assertRaw($offline_message, 'Found the site offline message.');
Chris@0: 
Chris@0:     // Verify that custom site offline message is not displayed on user/password.
Chris@0:     $this->drupalGet('user/password');
Chris@0:     $this->assertText(t('Username or email address'), 'Anonymous users can access user/password');
Chris@0: 
Chris@0:     // Submit password reset form.
Chris@0:     $edit = [
Chris@0:       'name' => $this->user->getUsername(),
Chris@0:     ];
Chris@0:     $this->drupalPostForm('user/password', $edit, t('Submit'));
Chris@0:     $mails = $this->drupalGetMails();
Chris@0:     $start = strpos($mails[0]['body'], 'user/reset/' . $this->user->id());
Chris@0:     $path = substr($mails[0]['body'], $start, 66 + strlen($this->user->id()));
Chris@0: 
Chris@0:     // Log in with temporary login link.
Chris@0:     $this->drupalPostForm($path, [], t('Log in'));
Chris@0:     $this->assertText($user_message);
Chris@0: 
Chris@0:     // Regression test to check if title displays in Bartik on maintenance page.
Chris@0:     \Drupal::service('theme_handler')->install(['bartik']);
Chris@0:     $this->config('system.theme')->set('default', 'bartik')->save();
Chris@0: 
Chris@0:     // Logout and verify that offline message is displayed in Bartik.
Chris@0:     $this->drupalLogout();
Chris@0:     $this->drupalGet('');
Chris@0:     $this->assertEqual('Site under maintenance', $this->cssSelect('main h1')[0]);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests responses to non-HTML requests when in maintenance mode.
Chris@0:    */
Chris@0:   public function testNonHtmlRequest() {
Chris@0:     $this->drupalLogout();
Chris@0:     \Drupal::state()->set('system.maintenance_mode', TRUE);
Chris@0:     $formats = ['json', 'xml', 'non-existing'];
Chris@0:     foreach ($formats as $format) {
Chris@0:       $this->pass('Testing format ' . $format);
Chris@0:       $this->drupalGet('<front>', ['query' => ['_format' => $format]]);
Chris@0:       $this->assertResponse(503);
Chris@0:       $this->assertRaw('Drupal is currently under maintenance. We should be back shortly. Thank you for your patience.');
Chris@0:       $this->assertHeader('Content-Type', 'text/plain; charset=UTF-8');
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0: }