test: Add e2e testing (#5)

Author: TheLandolorien

.github/hooks/pre-commit

@@ -18,7 +18,7 @@ else
 	exit 1
 fi
 
-unit_test_results=$(poetry run pytest --no-header --no-summary -qq tests/unit --cov-fail-under=90)
+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)
 if [[ "$?" == "0" ]]; then
 	echo "✅ Unit Tests"
 else

.github/hooks/pre-push

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-test_results=$(poetry run pytest --no-header -qq tests --cov-fail-under=90)
+test_results=$(poetry run pytest --no-header -qq tests/integration)
 if [[ "$?" == "0" ]]; then
 	echo "✅ Integration Tests"
 else

.github/workflows/ci.yml .github/workflows/build.yml.github/workflows/ci.yml renamed to .github/workflows/build.yml

@@ -53,5 +53,8 @@ jobs:
       - name: Lint Code
         run: poetry run pylint src tests
 
-      - name: Run Unit and Integration Tests
-        run: poetry run pytest tests --cov-fail-under=90
+      - name: Run Unit Tests
+        run: poetry run pytest --cov=src/package_name --cov-fail-under=90
+
+      - name: Run Integration Tests
+        run: poetry run pytest tests/integration

README.md

@@ -44,6 +44,7 @@ You can specify different paths to run different groupings of tests:
 ```shell
 pytest tests/unit         # Run unit tests
 pytest tests/integration  # Run integration tests
+pytest tests/e2e          # Run end-to-end tests
 pytest tests              # Run all tests
 ```
 

poetry.lock

@@ -21,6 +21,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.11"
+requests = "^2.31.0"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^7.4.0"
@@ -45,7 +46,7 @@ disable = ["missing-module-docstring"]
 minversion = "7.4.0"
 pythonpath = "src"
 testpaths = "tests/unit/package_name"
-addopts = "-vv --import-mode=importlib --cov=src/package_name --cov-report term-missing:skip-covered --cov-branch"
+addopts = "-vv --import-mode=importlib"
 
 [tool.poetry.scripts]
 package-name = "package_name.cli:run"

pyproject.toml

@@ -1,13 +1,28 @@
 import argparse
+import requests
 
 
 def run() -> None:
-    """Configures arg parser for package-name
+    """Entrypoint for package-name CLI tool
 
-    Configures the usage, args and sub-commands for the package-name.
+    Extracts CLI args and orchestrates execution path to run based on the args provided.
     """
-    parser = argparse.ArgumentParser(
-        prog="package-name",
-        description="Package description",
-    )
-    parser.print_help()
+
+    parser = _get_parser()
+    args = parser.parse_args()
+
+    if args.zen:
+        _get_zen()
+    else:
+        parser.print_help()
+
+
+def _get_zen() -> str:
+    print(requests.get(url="https://api.github.com/zen", timeout=30).text)
+
+
+def _get_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(prog="package-name", description="Package description")
+    parser.add_argument("--zen", "-z", action="store_true", help="print a random sentence of Zen")
+
+    return parser

src/package_name/cli.py

@@ -0,0 +1,8 @@
+import os
+
+
+def test_cli_zen_flag() -> None:
+    output = os.popen("poetry run package-name --zen").read()
+
+    assert output.endswith(".\n"), "should return zen sentence"
+    assert "usage" not in output, "should not print usage"

tests/e2e/test_cli.py

@@ -0,0 +1,14 @@
+import subprocess
+
+
+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"