-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ACMS-4237: Remove Dependency of acquia_cms_common from Site Studio.
- Loading branch information
1 parent
dc1ac52
commit 6bca830
Showing
6 changed files
with
276 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
modules/acquia_cms_site_studio/src/Facade/ConfigHandlerFacade.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| <?php | ||
|
|
||
| namespace Drupal\acquia_cms_site_studio\Facade; | ||
|
|
||
| use Drupal\Core\Config\ConfigFactoryInterface; | ||
| use Drupal\Core\DependencyInjection\ContainerInjectionInterface; | ||
| use Drupal\Core\Entity\EntityTypeManagerInterface; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
|
|
||
| /** | ||
| * Handles the configuration and settings for ACMS. | ||
| * | ||
| * @internal | ||
| * This is a totally internal part of Acquia CMS and may be changed in any | ||
| * way, or removed outright, at any time without warning. External code should | ||
| * not use this class! | ||
| */ | ||
| final class ConfigHandlerFacade implements ContainerInjectionInterface { | ||
|
|
||
| /** | ||
| * The config factory. | ||
| * | ||
| * @var \Drupal\Core\Config\ConfigFactoryInterface | ||
| */ | ||
| protected $configFactory; | ||
|
|
||
| /** | ||
| * The EntityTypeManager service. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityTypeManagerInterface | ||
| */ | ||
| protected $entityTypeManager; | ||
|
|
||
| /** | ||
| * The Module name. | ||
| * | ||
| * @var string | ||
| */ | ||
| protected string $moduleName; | ||
|
|
||
| /** | ||
| * ConfigHandlerFacade constructor. | ||
| * | ||
| * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory | ||
| * The config factory. | ||
| * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager | ||
| * Used to obtain data from various entity types. | ||
| */ | ||
| public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) { | ||
| $this->configFactory = $config_factory; | ||
| $this->entityTypeManager = $entity_type_manager; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function create(ContainerInterface $container) { | ||
| return new static( | ||
| $container->get('config.factory'), | ||
| $container->get('entity_type.manager') | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Set module name. | ||
| * | ||
| * @param string $name | ||
| * Module name. | ||
| * | ||
| * @return void | ||
| * Setting the module name. | ||
| */ | ||
| public function setModuleName(string $name): void { | ||
| $this->moduleName = $name; | ||
| } | ||
|
|
||
| /** | ||
| * Function to add default settings of node revision delete. | ||
| * | ||
| * @param array $settings | ||
| * Config settings data. | ||
| * | ||
| * @return void | ||
| * Saving the default settings. | ||
| */ | ||
| public function processConfigSettings(array $settings): void { | ||
| $config = $this->configFactory->getEditable("$this->moduleName.settings"); | ||
| foreach ($settings as $key => $value) { | ||
| $config->set($key, $value); | ||
| } | ||
| $config->save(); | ||
| } | ||
|
|
||
| /** | ||
| * Set third party settings for entity. | ||
| * | ||
| * @param array $entity | ||
| * Entity data. | ||
| * @param array $settings | ||
| * Third party setting data. | ||
| * | ||
| * @return void | ||
| * Saving the third party settings. | ||
| */ | ||
| public function processThirdPartySettings(array $entity, array $settings): void { | ||
| if ($entity) { | ||
| // Get the entity storage with respective entity_type. | ||
| $type = $this->entityTypeManager->getStorage($entity['entity_type']); | ||
| $entityLoad = $type->load($entity['bundle']); | ||
| // @phpstan-ignore-next-line | ||
| $getThirdPartySettings = $entityLoad ? $entityLoad->get('third_party_settings') : NULL; | ||
| // Set the third party settings. | ||
| if (!empty($entityLoad) && !isset($getThirdPartySettings[$this->moduleName])) { | ||
| foreach ($settings as $key => $value) { | ||
| // @phpstan-ignore-next-line | ||
| $entityLoad->setThirdPartySetting($this->moduleName, $key, $value); | ||
| } | ||
| $entityLoad->save(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
138 changes: 138 additions & 0 deletions
138
modules/acquia_cms_site_studio/tests/src/Traits/PermissionsTrait.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; | ||
|
|
||
| } |