Disabling an 'django.contrib.sites' app, causes error in tests with django.contrib.auth.tests.forms.PasswordResetFormTest

[Matt Harasymczuk]

Try disabling an 'django.contrib.sites' app, (which as it is a contrib app, should be an optional), and you'll get an error in tests with django.contrib.auth.tests.forms.PasswordResetFormTest.

[Dougal Matthews]

While the contrib apps should be optional, they do depend on each other. contrib.auth requires contrib.sites.

[Matt Harasymczuk]

I am not sure, I have been using contrib.auth without contrib.sites for a few years now.

[Dougal Matthews]

Hmm, maybe I'm wrong then. Feel free to re-open but you should provide more information including the traceback from the failing test.

[Matt Harasymczuk]

Creating test database for alias 'default'...
..............................................................E.................
................................................................................
................................................................................
................................................................................
......
======================================================================
ERROR: test_custom_email_subject (django.contrib.auth.tests.forms.PasswordResetFormTest)

---

Traceback (most recent call last):

File "C:\Python27\Lib\site-packages\django\contrib\auth\tests\forms.py", line 264, in test_custom_email_subject

form.save()

File "C:\Python27\Lib\site-packages\django\contrib\auth\forms.py", line 138, in save

current_site = get_current_site(request)

File "C:\Python27\Lib\site-packages\django\contrib\sites\models.py", line 94, in get_current_site

current_site = RequestSite(request)

File "C:\Python27\Lib\site-packages\django\contrib\sites\models.py", line 74, in init

self.domain = self.name = request.get_host()

AttributeError: 'NoneType' object has no attribute 'get_host'

---

Ran 326 tests in 5.113s

FAILED (errors=1)
Destroying test database for alias 'default'...

[Matt Harasymczuk]

it is fully functional without django.contrib.sites app, no errors, but this one test fails.

[Ramiro Morales]

What depends on the contrib.sites contrib apps is the contrib.auth.forms module. It changed in [13980] but it it already depended on it.

What tests are you running?

[Matt Harasymczuk]

python manage.py test in my project root directory

[Aymeric Augustin]

django.contrib.auth uses the get_current_site method of django.contrib.sites, which is safe to use, whether the sites framework is or isn't enabled.

However, when the sites framework isn't enabled, this method must receive the request in argument. In test_custom_email_subject, there is no request available, and the test crashes. Attached patch fixes this (and avoids relying on the default name of the default site).

[anonymous coward]

Why does this need tests when the diff fixes a failing test (TDD: "...first the developer writes a failing automated test case..."), and the change is 1 line.

[Julien Phalip]

True, I had been a bit too quick in my initial judgment and there is no need to write a test here. aaugustin made a good analysis of the issue and the patch seems reasonable. Also the domain_override attribute doesn't seem to be tested yet so that will increase the test suite's coverage. A comment should just be added to that line of code explaining that domain_override needs to be provided in the absence of a request object in case contrib.sites isn't installed -- this can be done on commit.

[Julien Phalip]

In [16717]:

Fixed #16412 -- Prevented a contrib.auth test from failing in the potential case where contrib.sites was not installed. Thanks to haras for the report and to Aymeric Augustin for the patch.

[Ramiro Morales]

(just fixing the mess I made with the description and summary of this ticket)