Documentation how to test custom management command missing

[wittwerch]

The documentation about custom management command misses a few points how to properly test them.
=> ​https://docs.djangoproject.com/en/1.7/howto/custom-management-commands/

For example the documentation states that you should use self.stdout: "By using these proxies, it becomes much easier to test your custom command"
But how to actually test the output is missing. A complete example with call_command would be great!

[Lagovas]

You can test commands like any other function. Just

from django.core.management import call_command
class SomeTest(TestCase):
    def test_command(self):
        call_command('your_command', *args, **kwargs) 
        self.assertTrue(somethingDone())

and test result or behavior of your command. I think no sense for writing how to test all functions or methods from docs.

[Claude Paroz]

I think an example wouldn't hurt, and show how you can catch the command output with six.StringIO (see tests/user_commands/tests.py).

[Danilo Bargen]

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

[Tim Graham]

Comments for improvement are on the PR.

[Tim Graham <timograham@…>]

In cdee8659763ee7044c1507bcd2202581b1744f0b:

Fixed #23543 -- Added docs on testing management command output.

[Tim Graham <timograham@…>]

In 60cf46fdf5176eb24ba4d47441ed24104f1493cc:

[1.7.x] Fixed #23543 -- Added docs on testing management command output.

Backport of cdee8659763ee7044c1507bcd2202581b1744f0b from master

[Tim Graham <timograham@…>]

In 276332d85c76a4de9fc1cb4bcb2f1636c0322414:

[1.6.x] Fixed #23543 -- Added docs on testing management command output.

Backport of cdee8659763ee7044c1507bcd2202581b1744f0b from master