ACMS-4237: Updated Site Studio tests to reflect the removal of the ac…

…quia_cms_common dependency.

modules/acquia_cms_site_studio/tests/src/Functional/FilterFormatFilteredHtmlTest.php

@@ -10,7 +10,7 @@
  * @group acquia_cms
  * @group acquia_cms_site_studio
  */
-class FilterFormatFilteredHtmlTest extends BrowserTestBase {
+class FilterFormatCohesionTest extends BrowserTestBase {
 
   /**
    * {@inheritdoc}
@@ -50,7 +50,7 @@ public function testFilterBlackListHtmlTags() {
     $this->drupalLogin($account);
 
     // Visit the filter page.
-    $this->drupalGet('/admin/config/content/formats/manage/filtered_html');
+    $this->drupalGet('/admin/config/content/formats/manage/cohesion');
     $assert_session->statusCodeEquals(200);
     $filter_element = $assert_session->elementExists('css', '#edit-filters-black-list-html-tags-status');
     $this->assertFalse($filter_element->isChecked(), 'Expect uncheck, but found checked.');

modules/acquia_cms_site_studio/tests/src/Traits/PermissionsTrait.php

@@ -0,0 +1,138 @@
+<?php
+
+namespace Drupal\Tests\acquia_cms_site_studio\Traits;
+
+use Drupal\user\Entity\Role;
+use Symfony\Component\Yaml\Yaml;
+
+/**
+ * Trait includes permissions matrix for Site Studio.
+ */
+trait PermissionsTrait {
+
+  /**
+   * Asserts that a role has a set of permissions.
+   *
+   * @param string $role
+   *   The ID of the role to check.
+   * @param string[] $permissions
+   *   An array of permissions the role is expected to have.
+   */
+  private function assertPermissions(string $role, array $permissions) : void {
+    $role = Role::load($role);
+    $missing_permissions = array_diff($permissions, $role->getPermissions());
+    $this->assertEmpty($missing_permissions, print_r($missing_permissions, TRUE));
+  }
+
+  /**
+   * Asserts that a role does not have a set of permissions.
+   *
+   * @param string $role
+   *   The ID of the role to check.
+   * @param string[] $permissions
+   *   An array of permissions the role is not expected to have.
+   */
+  private function assertNoPermissions(string $role, array $permissions) : void {
+    $role = Role::load($role);
+    $granted_permissions = array_intersect($role->getPermissions(), $permissions);
+    $this->assertEmpty($granted_permissions);
+  }
+
+  /**
+   * Gets the basePath for permission fixtures.
+   *
+   * @return string
+   *   Returns basePath for fixtures.
+   */
+  abstract public function getFixtureBasePath(): string;
+
+  /**
+   * @throws \Exception
+   */
+  protected function getPermissionsByRole(string $role): array {
+    $roleConfig = $this->getFixtureBasePath() . "/user.role.$role.yml";
+    $permissions = [];
+    if (file_exists($roleConfig)) {
+      $user_role = Yaml::parse(file_get_contents($roleConfig));
+      $permissions = $user_role['permissions'] ?? [];
+    }
+    if (!$permissions) {
+      throw new \Exception("Permissions yaml file not exist for role: $role.");
+    }
+    return $permissions;
+  }
+
+  /**
+   * Tests the role which should exists.
+   *
+   * @param array $roles
+   *   An array of roles which should exist.
+   * @param array $roles_not_exist
+   *   An array of roles which shouldn't exist.
+   *
+   * @dataProvider providerRoleExistNotExist
+   */
+  public function testRoleExistNotExist(array $roles, array $roles_not_exist = []) {
+    foreach ($roles as $role) {
+      $this->assertInstanceOf(Role::class, Role::load($role), "Role $role should exist.");
+    }
+    foreach ($roles_not_exist as $role) {
+      $this->assertNotInstanceOf(Role::class, Role::load($role), "Role $role should not exist.");
+    }
+  }
+
+  /**
+   * Tests basic capabilities of our user roles.
+   *
+   * - Content authors, editors, and administrators should all be able to access
+   *   the toolbar and the content overview.
+   * - User administrator should be able to access the toolbar and the user
+   *   overview.
+   *
+   * @dataProvider providerBasicPermissions
+   */
+  public function testBasicPermissions(string $role, array $permissions, array $no_permissions = []) {
+    $contrib_module_permissions = $this->contribModulePermissions($role);
+    if (!empty($contrib_module_permissions)) {
+      $permissions = array_merge($permissions, $contrib_module_permissions);
+    }
+    $this->assertPermissions($role, $permissions);
+    if ($no_permissions) {
+      $this->assertNoPermissions($role, $no_permissions);
+    }
+  }
+
+  /**
+   * Assign permissions only if the below modules are enabled.
+   *
+   * @param string $role
+   *   User role.
+   *
+   * @return array
+   *   Returns list of permissions.
+   */
+  public function contribModulePermissions($role): ?array {
+    $module_permissions = [];
+    if ($role === 'user_administrator') {
+      $module_handler = $this->container->get('module_handler');
+      $permissions = [
+        'shield' => 'administer shield',
+        'honeypot' => 'administer honeypot',
+        'captcha' => 'administer CAPTCHA settings',
+        'recaptcha' => 'administer recaptcha',
+      ];
+      foreach ($permissions as $module => $permission) {
+        if ($module_handler->moduleExists($module)) {
+          $module_permissions += [$permission];
+        }
+      }
+    }
+
+    return $module_permissions;
+  }
+
+  abstract public static function providerRoleExistNotExist(): array;
+
+  abstract public static function providerBasicPermissions(): array;
+
+}

modules/acquia_cms_site_studio/tests/src/fixtures/permissions/basic/user.role.developer.yml

@@ -43,6 +43,4 @@ permissions:
   - 'administer view templates'
   - 'administer website settings'
   - 'use text format cohesion'
-  - 'use text format filtered_html'
-  - 'use text format full_html'
   - 'view the administration theme'