chore: enhance E2E tests by adding synthetic global LLM config and updating environment variables for Google OAuth

This commit is contained in:
Anish Sarkar 2026-05-12 02:37:39 +05:30
parent 315329f344
commit 650b691a39
7 changed files with 170 additions and 9 deletions

View file

@ -119,9 +119,10 @@ jobs:
uses: actions/cache@v5 uses: actions/cache@v5
with: with:
path: surfsense_web/.next/cache path: surfsense_web/.next/cache
key: nextjs-${{ runner.os }}-${{ hashFiles('surfsense_web/pnpm-lock.yaml') }}-${{ hashFiles('surfsense_web/**/*.{js,jsx,ts,tsx}') }} key: nextjs-${{ runner.os }}-${{ hashFiles('surfsense_web/pnpm-lock.yaml') }}-${{ github.sha }}
restore-keys: | restore-keys: |
nextjs-${{ runner.os }}-${{ hashFiles('surfsense_web/pnpm-lock.yaml') }}- nextjs-${{ runner.os }}-${{ hashFiles('surfsense_web/pnpm-lock.yaml') }}-
nextjs-${{ runner.os }}-
# ─── Tests ───────────────────────────────────────────────────────── # ─── Tests ─────────────────────────────────────────────────────────
- name: Run Playwright tests - name: Run Playwright tests

View file

@ -13,5 +13,5 @@ celerybeat-schedule*
celerybeat-schedule.* celerybeat-schedule.*
celerybeat-schedule.dir celerybeat-schedule.dir
celerybeat-schedule.bak celerybeat-schedule.bak
global_llm_config.yaml /app/config/global_llm_config.yaml
app/templates/_generated/ app/templates/_generated/

View file

@ -0,0 +1,45 @@
# Synthetic Global LLM configuration for E2E ONLY.
#
# Why this file exists:
# surfsense_backend/app/config/global_llm_config.yaml is gitignored
# (operators ship real API keys there). In CI that file does not exist,
# so app.config.load_global_llm_configs() returns [], every chat-stream
# test fails fast with "No usable global LLM configs are available for
# Auto mode" raised by auto_model_pin_service._global_candidates().
#
# What this file does:
# tests/e2e/run_backend.py and tests/e2e/run_celery.py copy this file
# to app/config/global_llm_config.yaml at startup, BEFORE app.config
# is imported. The copy lives only inside the E2E Docker container.
#
# Why a fake api_key is safe:
# tests.e2e.fakes.chat_llm patches
# app.tasks.chat.stream_new_chat.create_chat_litellm_from_agent_config
# app.tasks.chat.stream_new_chat.create_chat_litellm_from_config
# so the resolved auto-pin id is never sent to a real LLM provider.
# The values below only need to pass
# auto_model_pin_service._is_usable_global_config()
# which requires id / model_name / provider / api_key all truthy.
router_settings:
routing_strategy: "simple-shuffle"
num_retries: 0
allowed_fails: 1
cooldown_time: 1
global_llm_configs:
- id: 1001
name: "E2E Fake Auto Model"
billing_tier: "free"
anonymous_enabled: false
seo_enabled: false
quality_score: 1.0
provider: "OPENAI"
model_name: "fake-e2e-model"
api_key: "fake-e2e-api-key-not-for-production"
supports_image_input: false
quota_reserve_tokens: 1024
rpm: 1000
tpm: 100000
litellm_params:
model: "openai/fake-e2e-model"

View file

@ -120,10 +120,74 @@ def _load_dotenv_and_set_env_defaults() -> None:
"DROPBOX_REDIRECT_URI", "DROPBOX_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/dropbox/connector/callback", "http://localhost:8000/api/v1/auth/dropbox/connector/callback",
) )
# Native Google OAuth — fake Flow in tests.e2e.fakes.native_google
# raises "Fake Google Flow requires redirect_uri." if these are empty,
# so connector/add routes return 500 in CI where no .env supplies them.
os.environ.setdefault(
"GOOGLE_DRIVE_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/google/drive/connector/callback",
)
os.environ.setdefault(
"GOOGLE_GMAIL_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/google/gmail/connector/callback",
)
os.environ.setdefault(
"GOOGLE_CALENDAR_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/google/calendar/connector/callback",
)
os.environ["SLACK_CLIENT_ID"] = "fake-slack-mcp-client-id" os.environ["SLACK_CLIENT_ID"] = "fake-slack-mcp-client-id"
os.environ["SLACK_CLIENT_SECRET"] = "fake-slack-mcp-client-secret" os.environ["SLACK_CLIENT_SECRET"] = "fake-slack-mcp-client-secret"
def _install_synthetic_global_llm_config() -> None:
"""Materialise a fake ``app/config/global_llm_config.yaml`` for E2E.
The real file is gitignored (production operators ship their own with
real API keys), so a fresh CI checkout has no YAML at the path
``app.config.load_global_llm_configs()`` reads. With an empty
``GLOBAL_LLM_CONFIGS`` list, ``auto_model_pin_service`` raises
``"No usable global LLM configs are available for Auto mode"`` on
every chat-stream request.
We copy the synthetic fixture from ``tests/e2e/fixtures/`` into the
production-expected location BEFORE ``_import_production_app()`` so
``app.config`` picks it up on import. Production code is untouched
this is purely a test-time scaffold.
Only installs when the destination is missing. A developer running
the E2E entrypoint locally keeps their real ``global_llm_config.yaml``
intact (the patched ``create_chat_litellm_from_*`` factories make the
actual model values irrelevant either way).
MUST run before _import_production_app().
"""
import shutil
src = os.path.join(_THIS_DIR, "fixtures", "global_llm_config.yaml")
dst = os.path.join(
_BACKEND_ROOT, "app", "config", "global_llm_config.yaml"
)
if not os.path.exists(src):
raise RuntimeError(
f"E2E synthetic global LLM config fixture missing at {src!r}. "
f"This file is checked into tests/e2e/fixtures/ — if it has gone "
f"missing, restore it from VCS before running the E2E entrypoint."
)
if os.path.exists(dst):
logger.info(
"[e2e-global-llm-config] %s already exists; leaving it alone "
"(local dev config preserved)",
dst,
)
return
os.makedirs(os.path.dirname(dst), exist_ok=True)
shutil.copyfile(src, dst)
logger.info("[e2e-global-llm-config] installed %s -> %s", src, dst)
def _import_production_app(): def _import_production_app():
"""Import and return the production FastAPI app. """Import and return the production FastAPI app.
@ -259,10 +323,12 @@ def _bootstrap():
1) Hijack composio + notion_client in sys.modules. 1) Hijack composio + notion_client in sys.modules.
2) Load .env + set env defaults (app.config reads env on import). 2) Load .env + set env defaults (app.config reads env on import).
3) Configure logging. 3) Configure logging.
4) Import production app (which transitively imports the now-faked 4) Materialise the synthetic global_llm_config.yaml so Auto-mode
external SDKs and reads the env defaults). pin resolution finds at least one usable candidate.
5) Patch LLM / embedding bindings at every consumer site. 5) Import production app (which transitively imports the now-faked
6) Mount test-only middleware + /__e2e__ routes onto the app. external SDKs and reads the env defaults + YAML).
6) Patch LLM / embedding bindings at every consumer site.
7) Mount test-only middleware + /__e2e__ routes onto the app.
""" """
_hijack_external_sdks() _hijack_external_sdks()
_load_dotenv_and_set_env_defaults() _load_dotenv_and_set_env_defaults()
@ -276,6 +342,7 @@ def _bootstrap():
"*** SURFSENSE E2E BACKEND ENTRYPOINT — fake Composio + LLM + embeddings ***" "*** SURFSENSE E2E BACKEND ENTRYPOINT — fake Composio + LLM + embeddings ***"
) )
_install_synthetic_global_llm_config()
production_app = _import_production_app() production_app = _import_production_app()
_patch_llm_bindings() _patch_llm_bindings()
_install_runtime_fakes() _install_runtime_fakes()

View file

@ -91,6 +91,20 @@ os.environ.setdefault(
"DROPBOX_REDIRECT_URI", "DROPBOX_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/dropbox/connector/callback", "http://localhost:8000/api/v1/auth/dropbox/connector/callback",
) )
# Native Google OAuth — fake Flow in tests.e2e.fakes.native_google raises
# "Fake Google Flow requires redirect_uri." when these are empty.
os.environ.setdefault(
"GOOGLE_DRIVE_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/google/drive/connector/callback",
)
os.environ.setdefault(
"GOOGLE_GMAIL_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/google/gmail/connector/callback",
)
os.environ.setdefault(
"GOOGLE_CALENDAR_REDIRECT_URI",
"http://localhost:8000/api/v1/auth/google/calendar/connector/callback",
)
os.environ["SLACK_CLIENT_ID"] = "fake-slack-mcp-client-id" os.environ["SLACK_CLIENT_ID"] = "fake-slack-mcp-client-id"
os.environ["SLACK_CLIENT_SECRET"] = "fake-slack-mcp-client-secret" os.environ["SLACK_CLIENT_SECRET"] = "fake-slack-mcp-client-secret"
@ -103,6 +117,40 @@ logger = logging.getLogger("surfsense.e2e.celery")
logger.warning("*** SURFSENSE E2E CELERY WORKER — fake Composio + LLM + embeddings ***") logger.warning("*** SURFSENSE E2E CELERY WORKER — fake Composio + LLM + embeddings ***")
# ---------------------------------------------------------------------------
# 2.5) Materialise the synthetic global_llm_config.yaml so the worker's
# view of app.config.GLOBAL_LLM_CONFIGS matches the API container.
# Must run BEFORE the production celery_app import below, which
# transitively imports app.config. Install-only-if-missing so a
# developer's local config (with real API keys) is preserved.
# ---------------------------------------------------------------------------
import shutil as _shutil # noqa: E402
_e2e_llm_cfg_src = os.path.join(_THIS_DIR, "fixtures", "global_llm_config.yaml")
_e2e_llm_cfg_dst = os.path.join(
_BACKEND_ROOT, "app", "config", "global_llm_config.yaml"
)
if not os.path.exists(_e2e_llm_cfg_src):
raise RuntimeError(
f"E2E synthetic global LLM config fixture missing at {_e2e_llm_cfg_src!r}. "
f"Restore tests/e2e/fixtures/global_llm_config.yaml from VCS."
)
if os.path.exists(_e2e_llm_cfg_dst):
logger.info(
"[e2e-global-llm-config] %s already exists; leaving it alone "
"(local dev config preserved)",
_e2e_llm_cfg_dst,
)
else:
os.makedirs(os.path.dirname(_e2e_llm_cfg_dst), exist_ok=True)
_shutil.copyfile(_e2e_llm_cfg_src, _e2e_llm_cfg_dst)
logger.info(
"[e2e-global-llm-config] installed %s -> %s",
_e2e_llm_cfg_src,
_e2e_llm_cfg_dst,
)
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# 3) Import the production celery_app. All task modules load here. # 3) Import the production celery_app. All task modules load here.
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------

View file

@ -27,7 +27,7 @@ export default defineConfig({
expect: { timeout: 15_000 }, expect: { timeout: 15_000 },
fullyParallel: true, fullyParallel: true,
forbidOnly: !!process.env.CI, forbidOnly: !!process.env.CI,
retries: process.env.CI ? 2 : 0, retries: process.env.CI ? 1 : 0,
workers: 1, workers: 1,
reporter: process.env.CI reporter: process.env.CI
? [["html", { open: "never" }], ["github"], ["list"]] ? [["html", { open: "never" }], ["github"], ["list"]]

View file

@ -107,14 +107,14 @@ test.describe("Manual file upload journey", () => {
}); });
}); });
test("user uploads a PDF (DOCUMENT branch via real Docling)", async ({ test("user uploads a PDF (DOCUMENT branch)", async ({
page, page,
request, request,
apiToken, apiToken,
searchSpace, searchSpace,
chatThread, chatThread,
}) => { }) => {
test.setTimeout(240_000); // Docling cold-start can take 30-60s on first invocation. test.setTimeout(180_000);
await uploadAndAssert({ await uploadAndAssert({
page, page,