[Django]-Test that user was logged in successfully

83πŸ‘

βœ…

This is not the best answer. See https://stackoverflow.com/a/35871564/307511

Chronial has given
an excellent example on how to make this assertion below. His answer
better than mine for nowadays code.


The most straightforward method to test if a user is logged in is by testing the Client object:

self.assertIn('_auth_user_id', self.client.session)

You could also check if a specific user is logged in:

self.assertEqual(int(self.client.session['_auth_user_id']), user.pk)

As an additional info, the response.request object is not a HttpRequest object; instead, it’s an ordinary dict with some info about the actual request, so it won’t have the user attribute anyway.

Also, testing the response.context object is not safe because you don’t aways have a context.

πŸ‘€emyller

109πŸ‘

You can use the get_user method of the auth module. It says it wants a request as parameter, but it only ever uses the session attribute of the request. And it just so happens that our Client has that attribute.

from django.contrib import auth
user = auth.get_user(self.client)
assert user.is_authenticated
πŸ‘€Chronial

11πŸ‘

Django’s TestClient has a login method which returns True if the user was successfully logged in.

9πŸ‘

The method is_authenticated() on the User model always returns True. False is returned for request.user.is_authenticated() in the case that request.user is an instance of AnonymousUser, which is_authenticated() method always returns False.
While testing you can have a look at response.context['request'].user.is_authenticated().

You can also try to access another page in test which requires to be logged in, and see if response.status returns 200 or 302 (redirect from login_required).

2πŸ‘

Where are you initialising your self.client? What else is in your setUp method? I have a similar test and your code should work fine. Here’s how I do it:

from django.contrib.auth.models import User
from django.test import TestCase
from django.test.client import Client


class UserTestCase(TestCase):

    def setUp(self):
        self.client = Client()

    def testLogin(self):
        print User.objects.all() # returns []
        response = self.client.post(reverse('auth-registration'), 
                            { 'username':'foo', 
                              'password1':'bar', 
                              'password2':'bar' } )
        print User.objects.all() # returns one user
        print User.objects.all()[0].is_authenticated() # returns True

EDIT

If I comment out my login logic, I don’t get any User after self.client.post(. If you really want to check if the user has been authenticated, use the self.client to access another url which requires user authentication. Continuing from the above, access another page:

response = self.client.get(reverse('another-page-which-requires-authentication'))
print response.status_code

The above should return 200 to confirm that the user has authenticated. Anything else, it will redirect to the login page with a 302 code.

πŸ‘€Thierry Lam

2πŸ‘

There is another succinct way, using wsgi_request in response:

response = self.client.post('/signup', data)
assert response.wsgi_request.user.is_authenticated()

and @Chronial β€˜s manner is also available with wsgi_request:

from django.contrib import auth
user = auth.get_user(response.wsgi_request)
assert user.is_authenticated()

Because response.wsgi_request object has a session attribute.

However, I think using response.wsgi_request.user is more simple.

πŸ‘€Anyany Pan

Leave a comment