Test/pattern for backend integration testing (#117)

* chore: Sperated tests into unit and integration tests

* chore: Added common test utility files.

* chore: Moved unit tests into tests/unit dir

* feat: Added backend integration tests.

* chore: Added Test PDF file.

* chore: Added poe script to run integration tests
Updated GitHub build action file.

* core: Added env config for test files.

* chore: Remove .ini env template formatting

* chore: Restore DOCQ_OPENAI_API_KEY name in env template files.

* chore: Load test env configs using python-dotenv

* chore: Restore DOCQ_OPENAI_API_KEY name

* chore: Separate unit tests from integration tests.
Fix local linting errors for test modules.

* chore: Update manual upload test.

* chore: Update integration settings to work with model selection.

* chore: Update manage_spaces.reindex to handle exceptions when model settings are not available.

* fix: Fix key error when trying to retrieve system settings before they are saved.

* chore: Re-organize imports.

* doc: Update getting started docs on how to run integration tests.

* fix: Fix circular dependency between m_users and m_organisation.

.gitignore

@@ -139,6 +139,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+pytest.env
 
 # Spyder project settings
 .spyderproject
@@ -186,4 +187,4 @@ docker.env
 
 # ignore docs dynamically generated at build time.
 /docs/api
-/docs/tests
+/docs/tests

docs/developer-guide/getting-started.md

@@ -57,9 +57,24 @@ Some useful examples of how this project can be used:
   ```
 
 - Run tests
+
+  - Unit tests
 
   ```sh
   poe test
+  ``` 
+
+  - Integration tests
+
+    - Prepare env vars by supplying a pytest.env file required for the integration tests
+
+      ```sh
+      cp misc/pytest.env.template pytest.env
+      ## Make edits on pytest.env with the correct values for the test environment then run the tests
+      ```
+
+  ```sh
+  poe test-integration
   ```
 
 - Run the project

misc/pytest.env.template

@@ -0,0 +1,8 @@
+# Copy and place the following file to the root of the project as pytest.env
+# To setup enviroment variables for integration testing
+DOCQ_DATA=./.persisted-test-integration/
+DOCQ_OPENAI_API_KEY=YOUR_OPEN_AI_KEY
+DOCQ_COOKIE_HMAC_SECRET_KEY=32_char_secret_used_to_encrypt
+
+# This will use the DOCQ_OPENAI_API_KEY for now.
+OPENAI_API_KEY=${DOCQ_OPENAI_API_KEY}

pyproject.toml

@@ -31,7 +31,7 @@ black = { version = "^22.3.0", allow-prereleases = true }
 xdoctest = "^1.0.0"
 poethepoet = "^0.16.4"
 ruff = "^0.0.253"
-pytest = "7.1.1"
+pytest = "7.3.1"
 pytest-html = "^3.1.1"
 pytest-sugar = "^0.9.6"
 pytest-reverse = "^1.5.0"
@@ -44,6 +44,7 @@ mkdocs-awesome-pages-plugin = "^2.8.0"
 mkapi = "^1.0.14"
 pillow = "^9.5.0"
 cairosvg = "^2.7.0"
+python-dotenv = "^1.0.0"
 
 [tool.poetry.scripts]
 -c = "poethepoet:main"
@@ -123,7 +124,8 @@ exclude_lines = [
 [tool.poe.tasks]
 install = "poetry install --only main"
 install-dev = "poetry install"
-test = "pytest"
+test = "pytest tests/unit"
+test-integration = "pytest tests/integration"
 pre-commit = "pre-commit run --all-files"
 lint-ruff = "ruff check **/*.py --fix"
 lint-black = "black **/*.py"

source/docq/manage_organisations.py

@@ -6,8 +6,7 @@
 from datetime import datetime
 from typing import List, Tuple
 
-from . import manage_settings
-from .manage_users import _add_organisation_member_sql
+from . import manage_settings, manage_users
 from .support.store import get_sqlite_system_file
 
 SQL_CREATE_ORGS_TABLE = """
@@ -146,7 +145,7 @@ def create_organisation(name: str, creating_user_id: int) -> int | None:
             _create_organisation_sql(cursor, name)
             org_id = cursor.lastrowid
             is_default_org_admin = True
-            _add_organisation_member_sql(cursor, org_id, creating_user_id, is_default_org_admin)
+            manage_users._add_organisation_member_sql(cursor, org_id, creating_user_id, is_default_org_admin)
             connection.commit()
             log.info("Created organization %s with member %s", org_id, creating_user_id)
         except Exception as e:

source/docq/manage_spaces.py

@@ -70,11 +70,9 @@ def _persist_index(index: GPTVectorStoreIndex, space: SpaceKey) -> None:
 
 def reindex(space: SpaceKey) -> None:
     """Reindex documents in a space."""
-    (ds_type, ds_configs) = get_space_data_source(space)
-
-    saved_model_settings = get_saved_model_settings_collection(space.org_id)
-
     try:
+        (ds_type, ds_configs) = get_space_data_source(space)
+        saved_model_settings = get_saved_model_settings_collection(space.org_id)
         log.debug("get datasource instance")
         documents = SpaceDataSources[ds_type].value.load(space, ds_configs)
         log.debug("docs to index, %s", len(documents))

source/docq/manage_users.py

@@ -356,11 +356,11 @@ def rnd():
 
             personal_org_id = cursor.lastrowid
 
-            manage_organisations._add_organisation_member_sql(cursor, personal_org_id, user_id, True)
+            _add_organisation_member_sql(cursor, personal_org_id, user_id, True)
 
             if org_id:
                 log.info("Adding user %s to org %s", user_id, org_id)
-                manage_organisations._add_organisation_member_sql(cursor, org_id, user_id, org_admin)
+                _add_organisation_member_sql(cursor, org_id, user_id, org_admin)
 
             connection.commit()
             log.info("Created user %s", user_id)

tests/integration/__init__.py

@@ -0,0 +1,4 @@
+"""Integration tests."""
+from dotenv import load_dotenv
+
+load_dotenv("pytest.env")