refactor(info): describe as @click.command

Author: thekaveman

compiler_admin/commands/info.py

@@ -1,17 +1,16 @@
-from compiler_admin import __version__ as version, RESULT_SUCCESS, RESULT_FAILURE
-from compiler_admin.services.google import CallGAMCommand, CallGYBCommand
+import click
 
+from compiler_admin import __version__ as version
+from compiler_admin.services.google import CallGAMCommand, CallGYBCommand
 
-def info(*args, **kwargs) -> int:
-    """Print information about this package and the GAM environment.
 
-    Returns:
-        A value indicating if the operation succeeded or failed.
+@click.command()
+def info():
     """
-    print(f"compiler-admin: {version}")
-
-    res = CallGAMCommand(("version",))
-    res += CallGAMCommand(("info", "domain"))
-    res += CallGYBCommand(("--version",))
+    Print information about the configured environment.
+    """
+    click.echo(f"compiler-admin, version {version}")
 
-    return RESULT_SUCCESS if res == RESULT_SUCCESS else RESULT_FAILURE
+    CallGAMCommand(("version",))
+    CallGAMCommand(("info", "domain"))
+    CallGYBCommand(("--version",))

tests/commands/test_info.py

@@ -1,8 +1,7 @@
 import pytest
 
-from compiler_admin import RESULT_SUCCESS
+from compiler_admin import RESULT_SUCCESS, __version__
 from compiler_admin.commands.info import info, __name__ as MODULE
-from compiler_admin.services.google import DOMAIN
 
 
 @pytest.fixture
@@ -15,21 +14,10 @@ def mock_google_CallGYBCommand(mock_google_CallGYBCommand):
     return mock_google_CallGYBCommand(MODULE)
 
 
-def test_info(mock_google_CallGAMCommand, mock_google_CallGYBCommand):
-    info()
+def test_info(cli_runner, mock_google_CallGAMCommand, mock_google_CallGYBCommand):
+    result = cli_runner.invoke(info)
 
+    assert result.exit_code == RESULT_SUCCESS
+    assert f"compiler-admin, version {__version__}" in result.output
     assert mock_google_CallGAMCommand.call_count > 0
     mock_google_CallGYBCommand.assert_called_once()
-
-
-@pytest.mark.e2e
-def test_info_e2e(capfd):
-    res = info()
-    captured = capfd.readouterr()
-
-    assert res == RESULT_SUCCESS
-    assert "compiler-admin:" in captured.out
-    assert "GAMADV-XTD3" in captured.out
-    assert f"Primary Domain: {DOMAIN}" in captured.out
-    assert "Got Your Back" in captured.out
-    assert "WARNING: Config File:" not in captured.err

tests/conftest.py

@@ -1,3 +1,5 @@
+from click.testing import CliRunner
+
 import pytest
 from pytest_socket import disable_socket
 
@@ -186,6 +188,11 @@ def _mock_NamedTemporaryFile(module, readlines=[""], **kwargs):
     return _mock_NamedTemporaryFile
 
 
+@pytest.fixture
+def cli_runner():
+    return CliRunner()
+
+
 @pytest.fixture
 def harvest_file():
     return "notebooks/data/harvest-sample.csv"