Skip to content

Commit

Permalink
Added the possibility to pass a stdin object to a management command.
Browse files Browse the repository at this point in the history
This makes testing certain features easier.

Thanks to AeroNotix for the original patch.
  • Loading branch information
bmispelon committed Feb 17, 2014
1 parent 3c547a4 commit 116d398
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions django/core/management/base.py
Expand Up @@ -306,6 +306,7 @@ def execute(self, *args, **options):
self.stderr = OutputWrapper(options.get('stderr', sys.stderr))
else:
self.stderr = OutputWrapper(options.get('stderr', sys.stderr), self.style.ERROR)
self.stdin = options.get('stdin', sys.stdin) # Useful for testing

if self.can_import_settings:
from django.conf import settings # NOQA
Expand Down
27 changes: 27 additions & 0 deletions tests/user_commands/tests.py
Expand Up @@ -2,6 +2,7 @@

from django.core import management
from django.core.management import CommandError
from django.core.management.base import BaseCommand
from django.core.management.utils import popen_wrapper
from django.test import SimpleTestCase
from django.utils import translation
Expand Down Expand Up @@ -60,6 +61,32 @@ def test_configured_locale_preserved(self):
management.call_command('leave_locale_alone_true', stdout=out)
self.assertEqual(out.getvalue(), "pl\n")

def test_passing_stdin(self):
"""
You can pass a stdin object to a command's options and it should be
available on self.stdin.
"""
class CustomCommand(BaseCommand):
def handle(self, *args, **kwargs):
pass

sentinel = object()
command = CustomCommand()
command.execute(stdin=sentinel, stdout=StringIO())
self.assertIs(command.stdin, sentinel)

def test_passing_stdin_default(self):
"""
If stdin is not passed as an option, the default should be sys.stdin.
"""
class CustomCommand(BaseCommand):
def handle(self, *args, **kwargs):
return 'OK'

command = CustomCommand()
command.execute(stdout=StringIO())
self.assertIs(command.stdin, sys.stdin)


class UtilsTests(SimpleTestCase):

Expand Down

0 comments on commit 116d398

Please sign in to comment.