How to use Impostor - 10 common examples

def test_login_admin_as_user(self):
        """
        checks that an admin user can impersonate a regular user via impostor backend
        and that the login get reflected into the ImpostorLog table
        :return:
        """
        assert ImpostorLog.objects.count() == 0

        composed_username = '{} as {}'.format(admin_username, user_username)
        u = authenticate(username=composed_username, password=admin_pass)
        real_user = get_user_model().objects.get(username=user_username)
        assert u == real_user

        # Check if logs contain an entry now
        logs_entries = ImpostorLog.objects.all()
        assert len(logs_entries) == 1

        entry = logs_entries[0]
        # today = datetime.date.today()
        # lin = entry.logged_in
        assert entry.impostor.username == admin_username
        assert entry.imposted_as.username == user_username

:param password:
        :param impersonated_user:
        :param expected:
        :param custom_settings:
        :param rf:
        :return:
        """
        setattr(rf, 'META', {})
        rf.META['HTTP_X_FORWARDED_FOR'] = '127.0.0.1,192.168.0.1'
        assert ImpostorLog.objects.count() == 0
        composed_username = '{} as {}'.format(first_user.username, impersonated_user.username)
        authenticated_user = authenticate(request=rf, username=composed_username, password=password)
        if expected == 'ok':
            assert authenticated_user == impersonated_user
            assert ImpostorLog.objects.count() == 1
            log = ImpostorLog.objects.first()
            assert log.impostor == first_user
            assert log.imposted_as == impersonated_user
            assert log.impostor_ip == '127.0.0.1'
        else:
            assert authenticated_user is None

def test_impersonated_as_tag(self, real_admin, real_user, rf, in_session, expected):
        obj = ImpostorLog.objects.create(impostor=real_admin, imposted_as=real_user)
        setattr(rf, 'session', {})
        if in_session:
            rf.session['impostor_token'] = obj.token
        result = get_impersonated_as(rf)
        if expected:
            assert result == obj
        else:
            assert result != obj

def test_impostor_log_str(self, real_admin, real_user):
        obj = ImpostorLog.objects.create(impostor=real_admin, imposted_as=real_user)
        assert str(obj) == '{} as {}'.format(real_admin.username, real_user.username)

:param first_user:
        :param password:
        :param impersonated_user:
        :param expected:
        :param custom_settings:
        :param rf:
        :return:
        """
        setattr(rf, 'META', {})
        rf.META['HTTP_X_FORWARDED_FOR'] = '127.0.0.1,192.168.0.1'
        assert ImpostorLog.objects.count() == 0
        composed_username = '{} as {}'.format(first_user.username, impersonated_user.username)
        authenticated_user = authenticate(request=rf, username=composed_username, password=password)
        if expected == 'ok':
            assert authenticated_user == impersonated_user
            assert ImpostorLog.objects.count() == 1
            log = ImpostorLog.objects.first()
            assert log.impostor == first_user
            assert log.imposted_as == impersonated_user
            assert log.impostor_ip == '127.0.0.1'
        else:
            assert authenticated_user is None

def test_impostor_group(self, custom_settings, existing_attr):
        """
        check impostor_group property
        :param custom_settings:
        :return:
        """
        if existing_attr:
            delattr(custom_settings, 'IMPOSTOR_GROUP')
            assert AuthBackend().impostor_group is None
        else:
            assert AuthBackend().impostor_group is not None

def test_get_user(self, user_passed, user_expected):
        """
        check get_user method
        :param user_passed:
        :param user_expected:
        :return:
        """
        try:
            user_id = user_passed.id
        except AttributeError:
            user_id = None
        result = AuthBackend.get_user(user_id)
        assert result == user_expected

def test_form(self):
        """
        test custom login form

        :return:
        """
        initial = {'username': user_username, 'password': user_pass}
        form = BigAuthenticationForm(data=initial)
        assert form.is_valid()
        assert form.cleaned_data['username'] == user_username
        assert form.cleaned_data['password'] == user_pass

        # Longer than contrib.auth default of 30 chars
        new_uname = '{} as {}'.format(admin_username, user_username)
        initial = {'username': new_uname, 'password': admin_pass}
        form = BigAuthenticationForm(data=initial)
        assert form.is_valid()
        assert form.cleaned_data['username'] == new_uname
        assert form.cleaned_data['password'] == admin_pass

        del initial['password']
        form = BigAuthenticationForm(data=initial)
        assert not form.is_valid()

initial = {'username': user_username, 'password': user_pass}
        form = BigAuthenticationForm(data=initial)
        assert form.is_valid()
        assert form.cleaned_data['username'] == user_username
        assert form.cleaned_data['password'] == user_pass

        # Longer than contrib.auth default of 30 chars
        new_uname = '{} as {}'.format(admin_username, user_username)
        initial = {'username': new_uname, 'password': admin_pass}
        form = BigAuthenticationForm(data=initial)
        assert form.is_valid()
        assert form.cleaned_data['username'] == new_uname
        assert form.cleaned_data['password'] == admin_pass

        del initial['password']
        form = BigAuthenticationForm(data=initial)
        assert not form.is_valid()

def test_login_admin_as_user(self):
        """
        checks that an admin user can impersonate a regular user via impostor backend
        and that the login get reflected into the ImpostorLog table
        :return:
        """
        assert ImpostorLog.objects.count() == 0

        composed_username = '{} as {}'.format(admin_username, user_username)
        u = authenticate(username=composed_username, password=admin_pass)
        real_user = get_user_model().objects.get(username=user_username)
        assert u == real_user

        # Check if logs contain an entry now
        logs_entries = ImpostorLog.objects.all()
        assert len(logs_entries) == 1

        entry = logs_entries[0]
        # today = datetime.date.today()
        # lin = entry.logged_in
        assert entry.impostor.username == admin_username
        assert entry.imposted_as.username == user_username

        # assert (lin.year == today.year and lin.month == today.month and lin.day == today.day)
        assert (entry.token and entry.token.strip() != "")