Add tests

Author: GaretJax

djclick/test/conftest.py

@@ -0,0 +1,58 @@
+import sys
+import os
+import contextlib
+import subprocess
+
+import pytest
+
+
+@contextlib.contextmanager
+def set_key(dictionary, key, value):
+    key_is_set = key in dictionary
+    original_value = dictionary.pop(key, None)
+
+    dictionary[key] = value
+
+    try:
+        yield
+    finally:
+        if key_is_set:
+            dictionary[key] = original_value
+        else:
+            del dictionary[key]
+
+
+@contextlib.contextmanager
+def insert_value(list, index, value):
+    list.insert(index, value)
+    try:
+        yield
+    finally:
+        if value in list:
+            list.pop(list.index(value))
+
+
+@pytest.yield_fixture(autouse=True, scope='session')
+def test_project():
+    project_dir = os.path.join(os.path.dirname(__file__), 'testprj')
+    with insert_value(sys.path, 0, project_dir):
+        with set_key(os.environ, 'DJANGO_SETTINGS_MODULE', 'testprj.settings'):
+            from django.conf import settings
+            assert 'testapp' in settings.INSTALLED_APPS
+
+            import django
+            if hasattr(django, 'setup'):
+                django.setup()
+
+            yield
+
+
+@pytest.fixture(scope='session')
+def manage():
+    def call(*args):
+        cmd = [
+            os.path.join(os.path.dirname(__file__), 'testprj', 'manage.py'),
+        ] + list(args)
+        return subprocess.check_output(cmd)
+
+    return call

djclick/test/test_adapter.py

@@ -0,0 +1,148 @@
+import locale
+import codecs
+
+import six
+
+import pytest
+
+import click
+
+from django.core.management import get_commands, call_command
+from django.core.management import execute_from_command_line
+
+import djclick
+
+
+todo = pytest.mark.xfail(reason='TODO')
+
+
+@pytest.mark.skipif(not six.PY3, reason='Only necessary on Python3')
+def test_not_ascii():
+    """Make sure that the systems preferred encoding is not `ascii`.
+
+    Otherwise `click` is raising a RuntimeError for Python3. For a detailed
+    description of this very problem please consult the following gist:
+    https://gist.github.com/hackebrot/937245251887197ef542
+
+    This test also checks that `tox.ini` explicitly copies the according
+    system environment variables to the test environments.
+    """
+    try:
+        preferred_encoding = locale.getpreferredencoding()
+        fs_enc = codecs.lookup(preferred_encoding).name
+    except Exception:
+        fs_enc = 'ascii'
+    assert fs_enc != 'ascii'
+
+
+def test_attributes():
+    for attr in click.__all__:
+        assert hasattr(djclick, attr)
+
+
+def test_command_recognized():
+    assert 'testcmd' in get_commands()
+
+
+def test_call_cli():
+    execute_from_command_line(['./manage.py', 'testcmd'])
+    with pytest.raises(RuntimeError):
+        execute_from_command_line(['./manage.py', 'testcmd', '--raise'])
+
+
+def test_call_command_args():
+    call_command('testcmd')
+    with pytest.raises(RuntimeError):
+        call_command('testcmd', '--raise')
+
+
+def test_call_command_kwargs():
+    call_command('testcmd', raise_when_called=False)
+    with pytest.raises(RuntimeError):
+        call_command('testcmd', raise_when_called=True)
+
+
+def test_call_command_kwargs_rename():
+    call_command('testcmd', **{'raise': False})
+    with pytest.raises(RuntimeError):
+        call_command('testcmd', **{'raise': True})
+
+
+def test_call_directly():
+    from testapp.management.commands.testcmd import command
+
+    command(raise_when_called=False)
+
+    with pytest.raises(RuntimeError):
+        command(raise_when_called=True)
+
+    with pytest.raises(RuntimeError):
+        command(**{'raise': True})
+
+
+@todo
+def test_django_verbosity():
+    assert False
+
+
+@todo
+def test_django_pythonpath():
+    assert False
+
+
+@todo
+def test_django_traceback():
+    assert False
+
+
+@pytest.mark.xfail(six.PY3, reason='Encoding issues')
+def test_django_settings(manage):
+    # The --settings switch only works from the command line (or if the django
+    # settings where not setup before... this means that we have to call it
+    # in a subprocess.
+    cmd = 'settingscmd'
+    assert manage(cmd) == 'default'
+    assert manage(cmd, '--settings', 'testprj.settings') == 'default'
+    assert manage(cmd, '--settings', 'testprj.settings_alt') == 'alternative'
+
+
+def test_django_color(capsys):
+    call_command('colorcmd')
+    out, err = capsys.readouterr()
+    # Not passing a --color/--no-color flag defaults to autodetection. As the
+    # command is run through the test suite, the autodetection defaults to
+    # --no-color
+    assert out == 'stdout'
+    assert err == 'stderr'
+
+    call_command('colorcmd', '--color')
+    out, err = capsys.readouterr()
+    assert out == click.style('stdout', fg='blue')
+    assert err == click.style('stderr', bg='red')
+
+    call_command('colorcmd', '--no-color')
+    out, err = capsys.readouterr()
+    assert out == 'stdout'
+    assert err == 'stderr'
+
+
+@pytest.mark.xfail(six.PY3, reason='Encoding issues')
+def test_django_help(manage):
+    # The -h/--help switches cause the program to exit. Invoking the command
+    # through execute_from_command_line would cause the test suit to exit as
+    # well... this means that we have to call it in a subprocess.
+    helps = [
+        manage('helpcmd', '-h'),
+        manage('helpcmd', '--help'),
+        manage('help', 'helpcmd'),
+    ]
+    assert len(set(helps)) == 1
+
+    help_text = helps[0]
+    assert 'HELP_CALLED' not in help_text
+    assert help_text.startswith('Usage: manage.py helpcmd ')
+
+
+@todo
+def test_django_version():
+    assert False

djclick/test/testprj/manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testprj.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

djclick/test/testprj/testapp/__init__.py

@@ -0,0 +1,7 @@
+import djclick as click
+
+
+@click.command()
+def command():
+    click.secho('stdout', fg='blue', nl=False)
+    click.secho('stderr', bg='red', err=True, nl=False)

djclick/test/testprj/testapp/management/__init__.py

@@ -0,0 +1,7 @@
+import djclick as click
+
+
+@click.command()
+def command():
+    # Just print some things which shall not be found in the output
+    click.echo('HELP_CALLED')

djclick/test/testprj/testapp/management/commands/__init__.py

@@ -0,0 +1,8 @@
+import djclick as click
+
+from django.conf import settings
+
+
+@click.command()
+def command():
+    click.echo(settings.SETTINGS_NAME, nl=False)

djclick/test/testprj/testapp/management/commands/colorcmd.py

@@ -0,0 +1,8 @@
+import djclick as click
+
+
+@click.command()
+@click.option('--raise', 'raise_when_called', is_flag=True)
+def command(raise_when_called):
+    if raise_when_called:
+        raise RuntimeError()