Merge pull request #785 from tisnik/lcore-680-doc-for-tests

LCORE-680: documentation generated for tests

Author: tisnik

scripts/gen_doc.py

@@ -7,6 +7,8 @@
 import ast
 from pathlib import Path
 
+DIRECTORIES = ["src", "tests/unit", "tests/integration", "tests/e2e"]
+
 
 def generate_docfile(directory):
     """Generate README.md in the CWD."""
@@ -48,10 +50,17 @@ def generate_documentation_on_path(path):
 
 def main():
     """Entry point to this script, regenerates documentation in all directories."""
-    generate_documentation_on_path("src/")
-    for path in Path("src").rglob("*"):
-        if path.is_dir():
-            generate_documentation_on_path(path)
+    for directory in DIRECTORIES:
+        generate_documentation_on_path(f"{directory}/")
+        for path in Path(directory).rglob("*"):
+            if path.is_dir():
+                if (
+                    path.name == "lightspeed_stack.egg-info"
+                    or path.name == "__pycache__"
+                    or ".ruff_cache" in str(path)
+                ):
+                    continue
+                generate_documentation_on_path(path)
 
 
 if __name__ == "__main__":

tests/e2e/README.md

@@ -0,0 +1,11 @@
+# List of source files stored in `tests/e2e/` directory
+
+## [__init__.py](__init__.py)
+End-to-end tests for the lightspeed-stack REST API service.
+
+## [gen_scenario_list.py](gen_scenario_list.py)
+Scenario list generator.
+
+## [test_api.py](test_api.py)
+End-to-end tests for basic REST API endpoints.
+

tests/e2e/__init__.py

@@ -1 +1 @@
-"""End to end tests for the lightspeed-stack REST API service."""
+"""End-to-end tests for the lightspeed-stack REST API service."""

tests/e2e/configs/README.md

@@ -0,0 +1,2 @@
+# List of source files stored in `tests/e2e/configs` directory
+

tests/e2e/configuration/README.md

@@ -0,0 +1,2 @@
+# List of source files stored in `tests/e2e/configuration` directory
+

tests/e2e/features/README.md

@@ -0,0 +1,5 @@
+# List of source files stored in `tests/e2e/features` directory
+
+## [environment.py](environment.py)
+Code to be called before and after certain events during testing.
+

tests/e2e/features/steps/README.md

@@ -0,0 +1,29 @@
+# List of source files stored in `tests/e2e/features/steps` directory
+
+## [__init__.py](__init__.py)
+Implementation of end-to-end tests steps.
+
+## [auth.py](auth.py)
+Implementation of common test steps.
+
+## [common.py](common.py)
+Implementation of common test steps.
+
+## [common_http.py](common_http.py)
+Common steps for HTTP-related operations.
+
+## [conversation.py](conversation.py)
+Implementation of common test steps.
+
+## [feedback.py](feedback.py)
+Implementation of common test steps for the feedback API.
+
+## [health.py](health.py)
+Implementation of common test steps.
+
+## [info.py](info.py)
+Implementation of common test steps.
+
+## [llm_query_response.py](llm_query_response.py)
+LLM query and response steps.
+

tests/e2e/features/steps/__init__.py

@@ -1 +1 @@
-"""Implementation of end to end tests steps."""
+"""Implementation of end-to-end tests steps."""

tests/e2e/features/steps/common_http.py

@@ -1,4 +1,4 @@
-"""Common steps for HTTP related operations."""
+"""Common steps for HTTP-related operations."""
 
 import json
 

tests/e2e/test_api.py

@@ -1 +1 @@
-"""Integration tests for basic REST API endpoints."""
+"""End-to-end tests for basic REST API endpoints."""