assertRedirects host parameter not in the doc

[mrknacky@…]

I was searching in the doc and in the web for changing the http_host of the last assertEqual test of assertRedirects and in the doc host parameter doesn't exist.

In order to find it I had to find it in the source code

[Tim Graham]

I'm not sure the use case for this, could you given an example? The docstring for assertRedirects says "Note that assertRedirects won't work for external links since it uses TestClient to do a request."

The assertion in the Django test suite:

self.assertRedirects(response, '/test_client/get_view/', host=host)

Could just as easily be rewritten:

self.assertRedirects(response, '​http://%s/test_client/get_view/' % host)

This was added in commit 30848dfe34bb027c40ae1902623bd2fb675f6424.

[Russell Keith-Magee]

Well, presumable the use case is documenting a feature that is available. This isn't asking for a new feature; it's documenting an existing one.

[Tim Graham]

I meant what is the use case for using a different host in assertRedirects (since assertRedirects doesn't work for external links). I'd like to be able to document why someone would want to use the argument.

[gajimenezmaggiora]

Pull request: ​https://github.com/django/django/pull/1131

[Tim Graham]

Please don't mark your own patch as RFC.

The patch looks ok, but I'm still not clear about how/why I would actually use the host parameter. As I noted earlier, the docstring says "Note that assertRedirects won't work for external links since it uses TestClient to do a request." Indeed, if I try to use assertRedirects on a view that returns something like HttpResponseRedirect("​http://www.djangoproject.com/download/"), the test client will attempt to fetch /download/ of the app that's being tested, not of djangoproject.com.

I see the test that was added when this was originally committed works by instantiating the TestClient like this: Client(HTTP_HOST=host), where host is 'django.testserver'. I'm all for documenting this if there's some use case, but as is, I think this will cause confusion.

[Tim Graham <timograham@…>]

In e3c7af18a307f9d020eb798bdad6cc63ab22dac9:

Fixed #19489 -- Documented host parameter of assertRedirects().

Thanks mrknacky at gmail.com for the report and gajimenezmaggiora
for the draft patch.

[Tim Graham <timograham@…>]

In c45fcd278b48b066ef03765c82005ba96183db09:

[1.7.x] Fixed #19489 -- Documented host parameter of assertRedirects().

Thanks mrknacky at gmail.com for the report and gajimenezmaggiora
for the draft patch.

Backport of e3c7af18a3 from master

[Tim Graham <timograham@…>]

In 735ece0b89b400b95c5e38ae640a7c3fe860c377:

[1.6.x] Fixed #19489 -- Documented host parameter of assertRedirects().

Thanks mrknacky at gmail.com for the report and gajimenezmaggiora
for the draft patch.

Backport of e3c7af18a3 from master