cli tests

Author: A-Baji

datajoint/__init__.py

@@ -51,6 +51,7 @@
     "key",
     "key_hash",
     "logger",
+    "cli",
 ]
 
 from .logging import logger
@@ -70,6 +71,7 @@
 from .attribute_adapter import AttributeAdapter
 from . import errors
 from .errors import DataJointError
+from .cli import cli
 
 ERD = Di = Diagram  # Aliases for Diagram
 schema = Schema  # Aliases for Schema

datajoint/cli.py

@@ -4,7 +4,7 @@
 import datajoint as dj
 
 
-def dj_cli(args: list = None):
+def cli(args: list = None):
     """
     Console interface for DataJoint Python
 
@@ -17,7 +17,7 @@ def dj_cli(args: list = None):
         conflict_handler="resolve",
     )
     parser.add_argument(
-        "-V", "--version", action="version", version=f"datajoint {dj.__version__}"
+        "-V", "--version", action="version", version=f"{dj.__name__} {dj.__version__}"
     )
     parser.add_argument(
         "-u",
@@ -74,4 +74,4 @@ def dj_cli(args: list = None):
 
 
 if __name__ == "__main__":
-    dj_cli()
+    cli()

setup.py

@@ -40,7 +40,7 @@
     ],
     packages=find_packages(exclude=["contrib", "docs", "tests*"]),
     entry_points={
-        "console_scripts": ["dj=datajoint.cli:dj_cli"],
+        "console_scripts": ["dj=datajoint.cli:cli", "datajoint=datajoint.cli:cli"],
     },
     install_requires=requirements,
     python_requires="~={}.{}".format(*min_py_version),

tests_old/test_cli.py

@@ -0,0 +1,124 @@
+"""
+Collection of test cases to test the dj cli
+"""
+
+import json
+import subprocess
+import pytest
+import datajoint as dj
+from .schema_simple import *
+
+
+def test_cli_version(capsys):
+    with pytest.raises(SystemExit) as pytest_wrapped_e:
+        dj.cli(args=["-V"])
+    assert pytest_wrapped_e.type == SystemExit
+    assert pytest_wrapped_e.value.code == 0
+
+    captured_output = capsys.readouterr().out
+    assert captured_output == f"{dj.__name__} {dj.__version__}\n"
+
+
+def test_cli_help(capsys):
+    with pytest.raises(SystemExit) as pytest_wrapped_e:
+        dj.cli(args=["--help"])
+    assert pytest_wrapped_e.type == SystemExit
+    assert pytest_wrapped_e.value.code == 0
+
+    captured_output = capsys.readouterr().out
+
+    assert (
+        "usage: datajoint [--help] [-V] [-u USER] [-p PASSWORD] [-h HOST]\n\
+                 [-s SCHEMAS [SCHEMAS ...]]"
+        in captured_output
+    )
+    assert "DataJoint console interface." in captured_output
+    assert "optional arguments:" in captured_output
+    assert "--help                show this help message and exit" in captured_output
+    assert (
+        "-V, --version         show program's version number and exit"
+        in captured_output
+    )
+    assert "-u USER, --user USER  Datajoint username" in captured_output
+    assert (
+        "-p PASSWORD, --password PASSWORD\n\
+                        Datajoint password"
+        in captured_output
+    )
+    assert "-h HOST, --host HOST  Datajoint host" in captured_output
+    assert (
+        "-s SCHEMAS [SCHEMAS ...], --schemas SCHEMAS [SCHEMAS ...]\n\
+                        A list of virtual module mappings in `db:schema ...`\n\
+                        format"
+        in captured_output
+    )
+
+
+def test_cli_config():
+    process = subprocess.Popen(
+        ["dj"],
+        stdin=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True,
+    )
+
+    process.stdin.write("dj.config\n")
+    process.stdin.flush()
+
+    stdout, stderr = process.communicate()
+
+    assert f"{dj.config}" in stdout
+
+
+def test_cli_args():
+    process = subprocess.Popen(
+        ["dj", "-utest_user", "-ptest_pass", "-htest_host"],
+        stdin=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True,
+    )
+
+    process.stdin.write("dj.config['database.user']\n")
+    process.stdin.write("dj.config['database.password']\n")
+    process.stdin.write("dj.config['database.host']\n")
+    process.stdin.flush()
+
+    stdout, stderr = process.communicate()
+    assert "test_user" in stdout
+    assert "test_pass" in stdout
+    assert "test_host" in stdout
+
+
+def test_cli_schemas():
+    process = subprocess.Popen(
+        ["dj", "-s", "djtest_test1:test_schema1", "djtest_relational:test_schema2"],
+        stdin=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True,
+    )
+
+    process.stdin.write("test_schema1.__dict__['__name__']\n")
+    process.stdin.write("test_schema1.__dict__['schema']\n")
+    process.stdin.write("test_schema1.TTest.fetch(as_dict=True)\n")
+    process.stdin.flush()
+
+    stdout, stderr = process.communicate()
+    fetch_res = [
+        {"key": 0, "value": 0},
+        {"key": 1, "value": 2},
+        {"key": 2, "value": 4},
+        {"key": 3, "value": 6},
+        {"key": 4, "value": 8},
+        {"key": 5, "value": 10},
+        {"key": 6, "value": 12},
+        {"key": 7, "value": 14},
+        {"key": 8, "value": 16},
+        {"key": 9, "value": 18},
+    ]
+    assert "dj repl\n\nschema modules:\n\n  - test_schema1\n  - test_schema2" in stderr
+    assert "'test_schema1'" == stdout[4:18]
+    assert "Schema `djtest_test1`" == stdout[23:44]
+    assert fetch_res == json.loads(stdout[50:295].replace("'", '"'))