"""
Tests of student.roles
"""


import ddt
from django.test import TestCase
from opaque_keys.edx.keys import CourseKey
from opaque_keys.edx.locator import LibraryLocator

from common.djangoapps.student.roles import (
    CourseAccessRole,
    CourseBetaTesterRole,
    CourseInstructorRole,
    CourseRole,
    CourseLimitedStaffRole,
    CourseStaffRole,
    CourseFinanceAdminRole,
    CourseSalesAdminRole,
    LibraryUserRole,
    CourseDataResearcherRole,
    GlobalStaff,
    OrgContentCreatorRole,
    OrgInstructorRole,
    OrgStaffRole,
    RoleCache,
    get_role_cache_key_for_course,
    ROLE_CACHE_UNGROUPED_ROLES__KEY
)
from common.djangoapps.student.role_helpers import get_course_roles, has_staff_roles
from common.djangoapps.student.tests.factories import AnonymousUserFactory, InstructorFactory, StaffFactory, UserFactory


class RolesTestCase(TestCase):
    """
    Tests of student.roles
    """

    def setUp(self):
        super().setUp()
        self.course_key = CourseKey.from_string('course-v1:course-v1:edX+toy+2012_Fall')
        self.course_loc = self.course_key.make_usage_key('course', '2012_Fall')
        self.anonymous_user = AnonymousUserFactory()
        self.student = UserFactory()
        self.global_staff = UserFactory(is_staff=True)
        self.course_staff = StaffFactory(course_key=self.course_key)
        self.course_instructor = InstructorFactory(course_key=self.course_key)
        self.orgs = ["Marvel", "DC"]

    def test_global_staff(self):
        assert not GlobalStaff().has_user(self.student)
        assert not GlobalStaff().has_user(self.course_staff)
        assert not GlobalStaff().has_user(self.course_instructor)
        assert GlobalStaff().has_user(self.global_staff)

    def test_has_staff_roles(self):
        assert has_staff_roles(self.global_staff, self.course_key)
        assert has_staff_roles(self.course_staff, self.course_key)
        assert has_staff_roles(self.course_instructor, self.course_key)
        assert not has_staff_roles(self.student, self.course_key)

    def test_get_course_roles(self):
        assert not list(get_course_roles(self.student))
        assert not list(get_course_roles(self.global_staff))
        assert list(get_course_roles(self.course_staff)) == [
            CourseAccessRole(
                user=self.course_staff,
                course_id=self.course_key,
                org=self.course_key.org,
                role=CourseStaffRole.ROLE,
            )
        ]
        assert list(get_course_roles(self.course_instructor)) == [
            CourseAccessRole(
                user=self.course_instructor,
                course_id=self.course_key,
                org=self.course_key.org,
                role=CourseInstructorRole.ROLE,
            )
        ]

    def test_group_name_case_sensitive(self):
        uppercase_course_id = "ORG/COURSE/NAME"
        lowercase_course_id = uppercase_course_id.lower()
        uppercase_course_key = CourseKey.from_string(uppercase_course_id)
        lowercase_course_key = CourseKey.from_string(lowercase_course_id)

        role = "role"

        lowercase_user = UserFactory()
        CourseRole(role, lowercase_course_key).add_users(lowercase_user)
        uppercase_user = UserFactory()
        CourseRole(role, uppercase_course_key).add_users(uppercase_user)

        assert CourseRole(role, lowercase_course_key).has_user(lowercase_user)
        assert not CourseRole(role, uppercase_course_key).has_user(lowercase_user)
        assert not CourseRole(role, lowercase_course_key).has_user(uppercase_user)
        assert CourseRole(role, uppercase_course_key).has_user(uppercase_user)

    def test_course_role(self):
        """
        Test that giving a user a course role enables access appropriately
        """
        assert not CourseStaffRole(self.course_key).has_user(self.student), \
            f'Student has premature access to {self.course_key}'
        CourseStaffRole(self.course_key).add_users(self.student)
        assert CourseStaffRole(self.course_key).has_user(self.student), \
            f"Student doesn't have access to {str(self.course_key)}"

        # remove access and confirm
        CourseStaffRole(self.course_key).remove_users(self.student)
        assert not CourseStaffRole(self.course_key).has_user(self.student), \
            f'Student still has access to {self.course_key}'

    def test_org_role(self):
        """
        Test that giving a user an org role enables access appropriately
        """
        assert not OrgStaffRole(self.course_key.org).has_user(self.student), \
            f'Student has premature access to {self.course_key.org}'
        OrgStaffRole(self.course_key.org).add_users(self.student)
        assert OrgStaffRole(self.course_key.org).has_user(self.student), \
            f"Student doesn't have access to {str(self.course_key.org)}"

        # remove access and confirm
        OrgStaffRole(self.course_key.org).remove_users(self.student)
        if hasattr(self.student, '_roles'):
            del self.student._roles
        assert not OrgStaffRole(self.course_key.org).has_user(self.student), \
            f'Student still has access to {self.course_key.org}'

    def test_org_and_course_roles(self):
        """
        Test that Org and course roles don't interfere with course roles or vice versa
        """
        OrgInstructorRole(self.course_key.org).add_users(self.student)
        CourseInstructorRole(self.course_key).add_users(self.student)
        assert OrgInstructorRole(self.course_key.org).has_user(self.student), \
            f"Student doesn't have access to {str(self.course_key.org)}"
        assert CourseInstructorRole(self.course_key).has_user(self.student), \
            f"Student doesn't have access to {str(self.course_key)}"

        # remove access and confirm
        OrgInstructorRole(self.course_key.org).remove_users(self.student)
        assert not OrgInstructorRole(self.course_key.org).has_user(self.student), \
            f'Student still has access to {self.course_key.org}'
        assert CourseInstructorRole(self.course_key).has_user(self.student), \
            f"Student doesn't have access to {str(self.course_key)}"

        # ok now keep org role and get rid of course one
        OrgInstructorRole(self.course_key.org).add_users(self.student)
        CourseInstructorRole(self.course_key).remove_users(self.student)
        assert OrgInstructorRole(self.course_key.org).has_user(self.student), \
            f'Student lost has access to {self.course_key.org}'
        assert not CourseInstructorRole(self.course_key).has_user(self.student), \
            f"Student doesn't have access to {str(self.course_key)}"

    def test_get_user_for_role(self):
        """
        test users_for_role
        """
        role = CourseStaffRole(self.course_key)
        role.add_users(self.student)
        assert len(role.users_with_role()) > 0

    def test_add_users_doesnt_add_duplicate_entry(self):
        """
        Tests that calling add_users multiple times before a single call
        to remove_users does not result in the user remaining in the group.
        """
        role = CourseStaffRole(self.course_key)
        role.add_users(self.student)
        assert role.has_user(self.student)
        # Call add_users a second time, then remove just once.
        role.add_users(self.student)
        role.remove_users(self.student)
        assert not role.has_user(self.student)

    def test_get_orgs_for_user(self):
        """
        Test get_orgs_for_user
        """
        role = OrgContentCreatorRole(org=self.orgs[0])
        assert len(role.get_orgs_for_user(self.student)) == 0
        role.add_users(self.student)
        assert len(role.get_orgs_for_user(self.student)) == 1
        role_second_org = OrgContentCreatorRole(org=self.orgs[1])
        role_second_org.add_users(self.student)
        assert len(role.get_orgs_for_user(self.student)) == 2


@ddt.ddt
class RoleCacheTestCase(TestCase):  # lint-amnesty, pylint: disable=missing-class-docstring

    IN_KEY_STRING = 'course-v1:edX+toy+2012_Fall'
    IN_KEY = CourseKey.from_string(IN_KEY_STRING)
    NOT_IN_KEY = CourseKey.from_string('course-v1:edX+toy+2013_Fall')

    ROLES = (
        (CourseStaffRole(IN_KEY), ('staff', IN_KEY, 'edX')),
        (CourseLimitedStaffRole(IN_KEY), ('limited_staff', IN_KEY, 'edX')),
        (CourseInstructorRole(IN_KEY), ('instructor', IN_KEY, 'edX')),
        (OrgStaffRole(IN_KEY.org), ('staff', None, 'edX')),
        (CourseFinanceAdminRole(IN_KEY), ('finance_admin', IN_KEY, 'edX')),
        (CourseSalesAdminRole(IN_KEY), ('sales_admin', IN_KEY, 'edX')),
        (LibraryUserRole(IN_KEY), ('library_user', IN_KEY, 'edX')),
        (CourseDataResearcherRole(IN_KEY), ('data_researcher', IN_KEY, 'edX')),
        (OrgInstructorRole(IN_KEY.org), ('instructor', None, 'edX')),
        (CourseBetaTesterRole(IN_KEY), ('beta_testers', IN_KEY, 'edX')),
    )

    def setUp(self):
        super().setUp()
        self.user = UserFactory()

    @ddt.data(*ROLES)
    @ddt.unpack
    def test_only_in_role(self, role, target):
        role.add_users(self.user)
        cache = RoleCache(self.user)
        assert cache.has_role(*target)

        for other_role, other_target in self.ROLES:
            if other_role == role:
                continue

            role_base_id = getattr(role, "BASE_ROLE", None)
            other_role_id = getattr(other_role, "ROLE", None)

            if other_role_id and role_base_id == other_role_id:
                assert cache.has_role(*other_target)
            else:
                assert not cache.has_role(*other_target)

    @ddt.data(*ROLES)
    @ddt.unpack
    def test_empty_cache(self, role, target):  # lint-amnesty, pylint: disable=unused-argument
        cache = RoleCache(self.user)
        assert not cache.has_role(*target)

    def test_get_role_cache_key_for_course_for_course_object_gets_string(self):
        """
        Given a valid course key object, get_role_cache_key_for_course
        should return the string representation of the key.
        """
        course_string = 'course-v1:edX+toy+2012_Fall'
        key = CourseKey.from_string(course_string)
        key = get_role_cache_key_for_course(key)
        assert key == course_string

    def test_get_role_cache_key_for_course_for_undefined_object_returns_default(self):
        """
        Given a value None, get_role_cache_key_for_course
        should return the default key for ungrouped courses.
        """
        key = get_role_cache_key_for_course(None)
        assert key == ROLE_CACHE_UNGROUPED_ROLES__KEY

    def test_role_cache_get_roles_set(self):
        """
        Test that the RoleCache.all_roles_set getter method returns a flat set of all roles for a user
        and that the ._roles attribute is the same as the set to avoid legacy behavior being broken.
        """
        lib0 = LibraryLocator.from_string('library-v1:edX+quizzes')
        course0 = CourseKey.from_string('course-v1:edX+toy+2012_Summer')
        course1 = CourseKey.from_string('course-v1:edX+toy2+2013_Fall')
        role_library_v1 = LibraryUserRole(lib0)
        role_course_0 = CourseInstructorRole(course0)
        role_course_1 = CourseInstructorRole(course1)

        role_library_v1.add_users(self.user)
        role_course_0.add_users(self.user)
        role_course_1.add_users(self.user)

        cache = RoleCache(self.user)
        assert cache.has_role('library_user', lib0, 'edX')
        assert cache.has_role('instructor', course0, 'edX')
        assert cache.has_role('instructor', course1, 'edX')

        assert len(cache.all_roles_set) == 3
        roles_set = cache.all_roles_set
        for role in roles_set:
            assert role.course_id.course in ('quizzes', 'toy2', 'toy')

        assert roles_set == cache._roles  # pylint: disable=protected-access

    def test_role_cache_roles_by_course_id(self):
        """
        Test that the RoleCache.roles_by_course_id getter method returns a dictionary of roles for a user
        that are grouped by course_id or if ungrouped by the ROLE_CACHE_UNGROUPED_ROLES__KEY.
        """
        lib0 = LibraryLocator.from_string('library-v1:edX+quizzes')
        course0 = CourseKey.from_string('course-v1:edX+toy+2012_Summer')
        course1 = CourseKey.from_string('course-v1:edX+toy2+2013_Fall')
        role_library_v1 = LibraryUserRole(lib0)
        role_course_0 = CourseInstructorRole(course0)
        role_course_1 = CourseInstructorRole(course1)
        role_org_staff = OrgStaffRole('edX')

        role_library_v1.add_users(self.user)
        role_course_0.add_users(self.user)
        role_course_1.add_users(self.user)
        role_org_staff.add_users(self.user)

        cache = RoleCache(self.user)
        roles_dict = cache.roles_by_course_id
        assert len(roles_dict) == 4
        assert roles_dict.get(ROLE_CACHE_UNGROUPED_ROLES__KEY).pop().role == 'staff'
        assert roles_dict.get('library-v1:edX+quizzes').pop().course_id.course == 'quizzes'
        assert roles_dict.get('course-v1:edX+toy+2012_Summer').pop().course_id.course == 'toy'
        assert roles_dict.get('course-v1:edX+toy2+2013_Fall').pop().course_id.course == 'toy2'