test: Create test to run executable

.github/workflows/tox.yaml

@@ -1,4 +1,4 @@
-name: pytest
+name: tox
 
 on:
   push:

.gitignore

@@ -2,6 +2,7 @@
 __pycache__/
 *.py[cod]
 *$py.class
+dist/
 
 # Environments
 .env
@@ -11,6 +12,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.tox/
 
 # Output files
 *.png

pyproject.toml

@@ -21,7 +21,7 @@ keywords=["shadow", "finder", "locator", "map"]
 "Bug Tracker" = "https://github.com/bellingcat/ShadowFinder/issues"
 
 [tool.poetry.scripts]
-shadowfinder = "shadowfinder:main_entrypoint"
+shadowfinder = "shadowfinder.__main__:main"
 
 [tool.poetry.dependencies]
 python =  ">=3.9,<3.13"

src/shadowfinder/__init__.py

@@ -1,3 +1,4 @@
 from .shadowfinder import ShadowFinder
+from .cli import ShadowFinderCli
 
-__all__ = ["ShadowFinder"]
+__all__ = ["ShadowFinder", "ShadowFinderCli"]

src/shadowfinder/__main__.py

@@ -1,10 +1,10 @@
-from cli import ShadowFinderCli
+from . import ShadowFinderCli
 import fire
 
 
-def main_entrypoint():
+def main():
     fire.Fire(ShadowFinderCli)
 
 
 if __name__ == "__main__":
-    main_entrypoint()
+    main()

tests/test_executable.py

@@ -0,0 +1,33 @@
+"""
+The tests in this file test that running shadowfinder as an executable behaves
+as expected.
+"""
+import subprocess
+
+
+def test_executable_without_args():
+    """Tests that running shadowfinder without any arguments returns the CLI's help string and 0 exit code."""
+    # GIVEN
+    expected = """
+NAME
+    shadowfinder
+
+SYNOPSIS
+    shadowfinder COMMAND
+
+COMMANDS
+    COMMAND is one of the following:
+
+     find
+       Find the shadow length of an object given its height and the date and time.
+
+     find_sun
+       Locate a shadow based on the solar altitude angle and the date and time.
+"""
+
+    # WHEN
+    result = subprocess.run(['shadowfinder'], capture_output=True, text=True)
+
+    # THEN
+    assert result.returncode == 0
+    assert result.stdout.strip() == expected.strip()