Add 'ping' command and rework to use 'main' command group

Author: ghukill

embeddings/cli.py

@@ -1,6 +1,6 @@
 import logging
+import time
 from datetime import timedelta
-from time import perf_counter
 
 import click
 
@@ -9,20 +9,43 @@
 logger = logging.getLogger(__name__)
 
 
-@click.command()
+@click.group("embeddings")
 @click.option(
-    "-v", "--verbose", is_flag=True, help="Pass to log at debug level instead of info"
+    "-v",
+    "--verbose",
+    is_flag=True,
+    help="Pass to log at debug level instead of info",
 )
-def main(*, verbose: bool) -> None:
-    start_time = perf_counter()
+@click.pass_context
+def main(
+    ctx: click.Context,
+    *,
+    verbose: bool,
+) -> None:
+    ctx.ensure_object(dict)
+    ctx.obj["start_time"] = time.perf_counter()
+
     root_logger = logging.getLogger()
     logger.info(configure_logger(root_logger, verbose=verbose))
     logger.info(configure_sentry())
     logger.info("Running process")
 
-    # Do things here!
+    def _log_command_elapsed_time() -> None:
+        elapsed_time = time.perf_counter() - ctx.obj["start_time"]
+        logger.info(
+            "Total time to complete process: %s", str(timedelta(seconds=elapsed_time))
+        )
+
+    ctx.call_on_close(_log_command_elapsed_time)
+
+
+@main.command()
+def ping() -> None:
+    """Emit 'pong' to debug logs and stdout."""
+    logger.debug("pong")
+    click.echo("pong")
+
 
-    elapsed_time = perf_counter() - start_time
-    logger.info(
-        "Total time to complete process: %s", str(timedelta(seconds=elapsed_time))
-    )
+if __name__ == "__main__":  # pragma: no cover
+    logger = logging.getLogger("embeddings.main")
+    main()

tests/test_cli.py

@@ -1,17 +1,16 @@
 from embeddings.cli import main
 
 
-def test_cli_no_options(caplog, runner):
-    result = runner.invoke(main)
+def test_cli_default_logging(caplog, runner):
+    result = runner.invoke(main, ["ping"])
     assert result.exit_code == 0
     assert "Logger 'root' configured with level=INFO" in caplog.text
-    assert "Running process" in caplog.text
-    assert "Total time to complete process" in caplog.text
 
 
-def test_cli_all_options(caplog, runner):
-    result = runner.invoke(main, ["--verbose"])
+def test_cli_debug_logging(caplog, runner):
+    with caplog.at_level("DEBUG"):
+        result = runner.invoke(main, ["--verbose", "ping"])
     assert result.exit_code == 0
     assert "Logger 'root' configured with level=DEBUG" in caplog.text
-    assert "Running process" in caplog.text
-    assert "Total time to complete process" in caplog.text
+    assert "pong" in caplog.text
+    assert "pong" in result.output