SuiteCRM-Core/tests/unit/phpunit/modules/ACLRoles/ACLRoleTest.php

<?php

use SuiteCRM\Test\SuitePHPUnitFrameworkTestCase;

class ACLRoleTest extends SuitePHPUnitFrameworkTestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        global $current_user;
        get_sugar_config_defaults();
        $current_user = BeanFactory::newBean('Users');
    }

    public function testACLRole(): void
    {
        // Execute the constructor and check for the Object type and type attribute
        $aclRole = BeanFactory::newBean('ACLRoles');
        self::assertInstanceOf('ACLRole', $aclRole);
        self::assertInstanceOf('SugarBean', $aclRole);

        self::assertEquals('ACLRoles', $aclRole->module_dir);
        self::assertEquals('ACLRole', $aclRole->object_name);
        self::assertEquals('acl_roles', $aclRole->table_name);
        self::assertEquals(true, $aclRole->new_schema);
        self::assertEquals(true, $aclRole->disable_row_level_security);
        self::assertEquals(true, $aclRole->disable_custom_fields);
    }

    public function testget_summary_text(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //test with name attribute set and verify it returns expected value.
        //it works only if name attribute is preset, throws exception otherwise
        $aclRole->name = 'test role';
        $name = $aclRole->get_summary_text();
        self::assertEquals('test role', $name);
    }

    public function testsetAction(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //take count of relationship initially and then after method execution and test if relationship count increases
        $initial_count = count($aclRole->retrieve_relationships('acl_roles_actions', array('role_id' => '1', 'action_id' => '1', 'access_override' => '90'), 'role_id'));
        $aclRole->setAction('1', '1', '90');
        $final_count = count($aclRole->retrieve_relationships('acl_roles_actions', array('role_id' => '1', 'action_id' => '1', 'access_override' => '90'), 'role_id'));

        self::assertGreaterThanOrEqual($initial_count, $final_count, "values were: [$initial_count], [$final_count]");
    }

    public function testmark_relationships_deleted(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //take count of relationship initially and then after method execution and test if relationship count decreases
        $initial_count = count($aclRole->retrieve_relationships('acl_roles_actions', array('role_id' => '1', 'action_id' => '1', 'access_override' => '90'), 'role_id'));
        $aclRole->mark_relationships_deleted('1');
        $final_count = count($aclRole->retrieve_relationships('acl_roles_actions', array('role_id' => '1', 'action_id' => '1', 'access_override' => '90'), 'role_id'));

        self::assertLessThanOrEqual($initial_count, $final_count, "values were: [$initial_count], [$final_count]");
    }

    public function testgetUserRoles(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //test with default/true getAsNameArray param value
        $result = $aclRole->getUserRoles('1');
        self::assertIsArray($result);

        //test with flase getAsNameArray param value
        $result = $aclRole->getUserRoles('1', false);
        self::assertIsArray($result);
    }

    public function testgetUserRoleNames(): void
    {
        //test with empty value
        $result = ACLRole::getUserRoleNames('');
        self::assertIsArray($result);

        //test with non empty but non existing role id value
        $result = ACLRole::getUserRoleNames('1');
        self::assertIsArray($result);
    }

    public function testgetAllRoles(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //test with returnAsArray default/flase
        $result = $aclRole->getAllRoles();
        self::assertIsArray($result);

        //test with returnAsArray true
        $result = $aclRole->getAllRoles(true);
        self::assertIsArray($result);
    }

    public function testgetRoleActions(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //test with empty value
        $result = $aclRole->getRoleActions('');
        self::assertIsArray($result);
        $exp = [
          'Accounts',
          'Alerts',
          'Bugs',
          'Calls',
          'Calls_Reschedule',
          'Campaigns',
          'AOP_Case_Events',
          'AOP_Case_Updates',
          'Cases',
          'Contacts',
          'AOS_Contracts',
          'Documents',
          'EAPM',
          'EmailTemplates',
          'EmailMarketing',
          'Emails',
          'FP_events',
          'ExternalOAuthConnection',
          'ExternalOAuthProvider',
          'InboundEmail',
          'AOD_Index',
          'AOD_IndexEvent',
          'AOS_Invoices',
          'AOK_Knowledge_Base_Categories',
          'AOK_KnowledgeBase',
          'Leads',
          'FP_Event_Locations',
          'jjwg_Maps',
          'jjwg_Address_Cache',
          'jjwg_Areas',
          'jjwg_Markers',
          'Meetings',
          'Notes',
          'Opportunities',
          'OutboundEmailAccounts',
          'AOS_PDF_Templates',
          'AOW_Processed',
          'AOS_Products',
          'AOS_Product_Categories',
          'AM_TaskTemplates',
          'ProjectTask',
          'Project',
          'AM_ProjectTemplates',
          'AOS_Quotes',
          'AOR_Reports',
          'AOR_Scheduled_Reports',
          'SecurityGroups',
          'Spots',
          'SurveyQuestionOptions',
          'SurveyQuestionResponses',
          'SurveyQuestions',
          'SurveyResponses',
          'Surveys',
          'Prospects',
          'ProspectLists',
          'Tasks',
          'TemplateSectionLine',
          'Users',
          'AOW_WorkFlow',
        ];
        self::assertEquals($exp, array_keys($result));

        //test with non empty but non existing role id value, initially no roles exist.
        $result = $aclRole->getRoleActions('1');
        self::assertIsArray($result);
        self::assertEquals($exp, array_keys($result));
    }

    public function testtoArray(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        //wihout any fields set
        $expected = array('id' => '', 'name' => '',  'description' => '');
        $actual = $aclRole->toArray();
        self::assertSame($expected, $actual);

        //with fileds pre populated
        $aclRole->id = '1';
        $aclRole->name = 'test';
        $aclRole->description = 'some description text';

        $expected = array('id' => '1', 'name' => 'test',  'description' => 'some description text');
        $actual = $aclRole->toArray();
        self::assertSame($expected, $actual);
    }

    public function testfromArray(): void
    {
        $aclRole = BeanFactory::newBean('ACLRoles');

        $arr = array('id' => '1', 'name' => 'test',  'description' => 'some description text');
        $aclRole->fromArray($arr);

        //verify that it sets the object attributes correctly
        self::assertSame($aclRole->id, '1');
        self::assertSame($aclRole->name, 'test');
        self::assertSame($aclRole->description, 'some description text');
    }
}