workspaces_route_lock-8.x-1.0-alpha5/tests/src/Functional/FunctionalIntegrationTest.php

<?php

namespace Drupal\Tests\workspaces_route_lock\Functional;

use Drupal\Core\Url;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\workspaces\Functional\WorkspaceTestUtilities;
use Drupal\workspaces\Entity\Workspace;
use Drupal\workspaces\WorkspaceInterface;
use Drupal\workspaces_route_lock\Entity\WorkspacesRouteLock;

/**
 * Simple test to ensure that main page loads with module enabled.
 *
 * @group workspaces_route_lock
 */
class FunctionalIntegrationTest extends BrowserTestBase {

  use WorkspaceTestUtilities;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'toolbar',
    'workspaces_route_lock',
  ];

  /**
   * The default theme to use.
   *
   * @var string
   */
  protected $defaultTheme = 'classy';

  /**
   * A user with permission to administer site configuration.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $user;

  /**
   * The workspaces manager service.
   *
   * @var \Drupal\workspaces\WorkspaceManagerInterface
   */
  protected $workspacesManager;

  /**
   * The dev workspace.
   *
   * @var WorkspaceInterface
   */
  protected $devWorkspace;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->workspacesManager = $this->container->get('workspaces.manager');
    $this->user = $this->drupalCreateUser([
      'access administration pages',
      'access toolbar',
      'administer site configuration',
      'administer workspaces',
      'create workspace',
      'edit own workspace',
      'edit any workspace',
      'view own workspace',
    ]);
    $this->drupalLogin($this->user);
    $this->createWorkspaceThroughUi('Dev', 'dev');
    $this->devWorkspace = Workspace::load('dev');
  }

  /**
   * Tests that the system routes are locked as needed.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function testSystemRoutes() {
    // Lock the /admin page to stage and dev.
    WorkspacesRouteLock::create([
      'id' => 'system_admin',
      'label' => 'system.admin',
      'workspaces' => ['stage', 'dev'],
    ])->save();
    // Local all the paths that start with system.admin_s.
    WorkspacesRouteLock::create([
      'id' => 'system_admin_config_s_',
      'label' => 'system.admin_config_s*',
      'workspaces' => ['stage'],
    ])->save();

    $this->drupalGet(Url::fromRoute('<front>'));
    $this->assertActiveWorkspace('Live');

    $this->drupalGet(Url::fromRoute('system.admin'));
    $this->assertActiveWorkspace('Stage');

// TODO: Make it pass.
//    $this->switchToWorkspace($this->devWorkspace);
//    $this->drupalGet(Url::fromRoute('system.admin'));
//    $this->assertActiveWorkspace('Dev');

    $this->drupalGet(Url::fromRoute('system.admin_config_search'));
    $this->assertActiveWorkspace('Stage');

    $this->drupalGet(Url::fromRoute('system.admin_config_system'));
    $this->assertActiveWorkspace('Stage');

    $this->drupalGet(Url::fromRoute('system.admin_config_regional'));
    $this->assertActiveWorkspace('Live');
  }

  /**
   * Asserts the active workspace name.
   *
   * @param string $name
   *   The name of the workspace as displayed in the toolbar.
   *
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  protected function assertActiveWorkspace($name) {
    $this->assertSession()->statusCodeEquals(200);
    $link = $this->getSession()->getPage()->findLink('Switch workspace');
    $this->assertEquals($name, $link->getText(), 'The active workspaces matches the expected value ' . $name . '.');
  }

}