Merge pull request #4 from blackary/parameterize-test

Parameterize test to separate out test on each page, and give each test auto-generated name

Author: sfc-gh-jcarroll

st_smoke_test.py

@@ -1,23 +1,49 @@
 import os
-import glob
 import unittest
+from pathlib import Path
+
 from streamlit.testing.v1 import AppTest
 
 APP_PATH = os.getenv("APP_PATH", default="streamlit_app.py")
-SKIP_SMOKE = os.getenv("SKIP_SMOKE", 'False').lower() in ('true', '1', 't')
+SKIP_SMOKE = os.getenv("SKIP_SMOKE", "False").lower() in ("true", "1", "t")
+
+
+def get_file_paths() -> list[str]:
+    """Get a list of file paths for the main page + each page in the pages folder."""
+    page_folder = Path(APP_PATH).parent / "pages"
+    if not page_folder.exists():
+        return [APP_PATH]
+    page_files = page_folder.glob("*.py")
+    file_paths = [str(file.absolute().resolve()) for file in page_files]
+    return [APP_PATH] + file_paths
+
+
+def pytest_generate_tests(metafunc):
+    """
+    This is a special function that is called automatically by pytest to generate tests.
+    https://docs.pytest.org/en/7.1.x/how-to/parametrize.html#pytest-generate-tests
+
+    This generates list of file paths for each page in the pages folder, which will
+    automatically be used if a test function has an argument called "file_path".
+
+    Each file path will be the absolute path to each file, but the test ids will be
+    just the file name. This is so that the test output is easier to read.
+
+    st_smoke_test.py::test_smoke_page[streamlit_app.py] PASSED                  [ 33%]
+    st_smoke_test.py::test_smoke_page[p1.py] PASSED                             [ 66%]
+    st_smoke_test.py::test_smoke_page[p2.py] PASSED                             [100%]
+    """
+    if "file_path" in metafunc.fixturenames:
+        metafunc.parametrize(
+            "file_path", get_file_paths(), ids=lambda x: x.split("/")[-1]
+        )
 
-@unittest.skipIf(SKIP_SMOKE, "smoke test is disabled by config")
-def test_smoke_main():
-    at = AppTest.from_file(APP_PATH, default_timeout = 100).run()
-    assert not at.exception
 
 @unittest.skipIf(SKIP_SMOKE, "smoke test is disabled by config")
-def test_smoke_pages():
-    pages_pattern = os.path.join(os.path.dirname(APP_PATH), "pages/*.py")
-    page_files = glob.glob(pages_pattern)
-    if not page_files:
-        raise unittest.SkipTest("No pages found")
-    for file in page_files:
-        file_path  = os.path.abspath(file)
-        at = AppTest.from_file(file_path, default_timeout = 100).run()
-        assert not at.exception
+def test_smoke_page(file_path):
+    """
+    This will run a basic test on each page in the pages folder, checking to see that
+    there are no exceptions raised while the app runs.
+    """
+    at = AppTest.from_file(file_path, default_timeout=100).run()
+    assert not at.exception