First pass at tests for the command-line client

lovelydinosaur · lovelydinosaur · commit 9e4119495448 · 2016-01-15T16:35:17.000Z
diff --git a/coreapi/commandline.py b/coreapi/commandline.py
@@ -5,13 +5,27 @@
 import sys
 
 
-config_path = os.path.join(os.path.expanduser('~'), '.coreapi')
+config_path = None
 
-document_path = os.path.join(config_path, 'document.json')
-history_path = os.path.join(config_path, 'history.json')
-credentials_path = os.path.join(config_path, 'credentials.json')
-headers_path = os.path.join(config_path, 'headers.json')
-bookmarks_path = os.path.join(config_path, 'bookmarks.json')
+document_path = None
+history_path = None
+credentials_path = None
+headers_path = None
+bookmarks_path = None
+
+
+def setup_paths():
+    global config_path, document_path, history_path
+    global credentials_path, headers_path, bookmarks_path
+
+    default_dir = os.path.join(os.path.expanduser('~'), '.coreapi')
+    config_path = os.environ.get('COREAPI_CONFIG_DIR', default_dir)
+
+    document_path = os.path.join(config_path, 'document.json')
+    history_path = os.path.join(config_path, 'history.json')
+    credentials_path = os.path.join(config_path, 'credentials.json')
+    headers_path = os.path.join(config_path, 'headers.json')
+    bookmarks_path = os.path.join(config_path, 'bookmarks.json')
 
 
 def coerce_key_types(doc, keys):
@@ -82,6 +96,8 @@ def display(doc):
 @click.option('--version', is_flag=True, help='Display the package version number.')
 @click.pass_context
 def client(ctx, version):
+    setup_paths()
+
     if os.path.isfile(config_path):
         os.remove(config_path)
     if not os.path.isdir(config_path):
diff --git a/runtests b/runtests
@@ -10,7 +10,7 @@ PYTEST_ARGS = ['tests', '--tb=short']
 FLAKE8_ARGS = ['coreapi', 'tests', '--ignore=E501']
 COVERAGE_OPTIONS = {
     'include': ['coreapi/*', 'tests/*'],
-    'omit': ['coreapi/compat.py', 'coreapi/commandline.py']
+    'omit': ['coreapi/compat.py']
 }
 
 
diff --git a/tests/test_commandline.py b/tests/test_commandline.py
@@ -1,5 +1,27 @@
 from coreapi import Document, Link
-from coreapi.commandline import coerce_key_types
+from coreapi.commandline import client, coerce_key_types
+from click.testing import CliRunner
+import coreapi
+import pytest
+import os
+import shutil
+import tempfile
+
+
+@pytest.fixture(scope="function")
+def runner(request):
+    """
+    A fixture returning a runner for the command line client.
+    """
+    config_dir = tempfile.mkdtemp()
+    os.environ['COREAPI_CONFIG_DIR'] = config_dir
+
+    def finalize():
+        shutil.rmtree(config_dir)
+
+    runner = CliRunner()
+    request.addfinalizer(finalize)
+    return runner
 
 
 # Test dotted path notation maps to list of keys correctly.
@@ -20,3 +42,11 @@ def test_dotted_path_notation_with_invalid_key():
     doc = Document({'rows': [Document({'edit': Link()})]})
     keys = coerce_key_types(doc, ['dummy', '0', 'edit'])
     assert keys == ['dummy', '0', 'edit']
+
+
+# Integration tests
+
+def test_usage(runner):
+    result = runner.invoke(client, ['--version'])
+    assert result.output == 'coreapi version %s\n' % coreapi.__version__
+    assert result.exit_code == 0

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ PYTEST_ARGS = ['tests', '--tb=short']`
`10`	`10`	`FLAKE8_ARGS = ['coreapi', 'tests', '--ignore=E501']`
`11`	`11`	`COVERAGE_OPTIONS = {`
`12`	`12`	`'include': ['coreapi/', 'tests/'],`
`13`		`- 'omit': ['coreapi/compat.py', 'coreapi/commandline.py']`
	`13`	`+ 'omit': ['coreapi/compat.py']`
`14`	`14`	`}`
`15`	`15`
`16`	`16`