test: Re-organize testing types

Author: TheLandolorien

.github/hooks/pre-commit

@@ -18,11 +18,11 @@ else
 	exit 1
 fi
 
-unit_test_results=$(poetry run pytest --no-header --no-summary -qq --cov=src/package_name --cov-report term-missing:skip-covered --cov-branch --cov-fail-under=90 tests/unit)
+test_results=$(poetry run pytest --no-header --no-summary -qq --cov=src/package_name --cov-report term-missing:skip-covered --cov-branch --cov-fail-under=90)
 if [[ "$?" == "0" ]]; then
-	echo "✅ Unit Tests"
+	echo "✅ Unit/Integration Tests"
 else
-	echo "❌ Unit Tests"
-	echo "$unit_test_results"
+	echo "❌ Unit/Integration Tests"
+	echo "$test_results"
 	exit 1
 fi

.github/hooks/pre-push

@@ -1,10 +1,10 @@
 #!/bin/sh
 
-test_results=$(poetry run pytest --no-header -qq tests/integration)
+test_results=$(poetry run pytest --no-header -qq tests/e2e)
 if [[ "$?" == "0" ]]; then
-	echo "✅ Integration Tests"
+	echo "✅ End-to-End Tests"
 else
-	echo "❌ Integration Tests"
+	echo "❌ End-to-End Tests"
 	echo "$test_results"
 	exit 1
 fi

pyproject.toml

@@ -45,7 +45,7 @@ disable = ["missing-module-docstring"]
 [tool.pytest.ini_options]
 minversion = "7.4.0"
 pythonpath = "src"
-testpaths = "tests/unit/package_name"
+testpaths = ["tests/unit", "tests/integration"]
 addopts = "-vv --import-mode=importlib"
 
 [tool.poetry.scripts]

tests/e2e/test_cli.py

@@ -1,6 +1,18 @@
 import os
 
 
+def test_cli_default() -> None:
+    output = os.popen("poetry run package-name").read()
+
+    assert output == (
+        "usage: package-name [-h] [--zen]\n\n"
+        "Package description\n\n"
+        "options:\n"
+        "  -h, --help  show this help message and exit\n"
+        "  --zen, -z   print a random sentence of Zen\n"
+    ), "should display default output"
+
+
 def test_cli_zen_flag() -> None:
     output = os.popen("poetry run package-name --zen").read()
 

tests/integration/test_cli.py

@@ -1,14 +1,23 @@
-import subprocess
+from unittest.mock import patch
 
+from package_name import cli
 
-def test_default_command() -> None:
-    with subprocess.Popen(args=["package-name"], stdout=subprocess.PIPE) as proc:
-        output = proc.stdout.read()
 
-    assert output.decode() == (
-        "usage: package-name [-h] [--zen]\n\n"
-        "Package description\n\n"
-        "options:\n"
-        "  -h, --help  show this help message and exit\n"
-        "  --zen, -z   print a random sentence of Zen\n"
-    ), "should display default output"
+@patch("package_name.cli.requests")
+@patch("package_name.cli.argparse._sys.argv")
+def test_cli_default_command(mock_argv, mock_requests) -> None:
+    mock_argv.__getitem__.return_value = []
+
+    cli.run()
+
+    mock_requests.get.assert_not_called()
+
+
+@patch("package_name.cli.requests")
+@patch("package_name.cli.argparse._sys.argv")
+def test_cli_zen_command(mock_argv, mock_requests) -> None:
+    mock_argv.__getitem__.return_value = ["--zen"]
+
+    cli.run()
+
+    mock_requests.get.assert_called_once_with(url="https://api.github.com/zen", timeout=30)

tests/unit/package_name/test_cli.py

@@ -1,28 +1,13 @@
-from unittest.mock import patch
+import argparse
 
 from package_name import cli
 
 
-@patch("package_name.cli.argparse")
-@patch("package_name.cli.requests")
-def test_run_with_no_args(mock_requests, mock_argparse) -> None:
-    mock_argparse.ArgumentParser.return_value.parse_args.return_value.zen = False
+def test_get_parser() -> None:
+    parser = cli._get_parser()  # pylint: disable=W0212
+    args = parser.parse_args(["--zen"])
 
-    cli.run()
-
-    mock_argparse.ArgumentParser.assert_called_once_with(
-        prog="package-name", description="Package description"
-    )
-    mock_requests.get.assert_not_called()
-    mock_argparse.ArgumentParser.return_value.print_help.assert_called_once()
-
-
-@patch("package_name.cli.argparse")
-@patch("package_name.cli.requests")
-def test_run_with_zen_flag(mock_requests, mock_argparse) -> None:
-    mock_argparse.ArgumentParser.return_value.parse_args.return_value.zen = True
-
-    cli.run()
-
-    mock_requests.get.assert_called_once_with(url="https://api.github.com/zen", timeout=30)
-    mock_argparse.ArgumentParser.return_value.print_help.assert_not_called()
+    assert isinstance(parser, argparse.ArgumentParser), "should instantiate parser instance"
+    assert parser.prog == "package-name", "should set CLI tool name"
+    assert parser.description == "Package description", "should set CLI tool description"
+    assert args.zen, "should parse zen flag to True"