From 649ff6395bdca06530ceabd3e216c66851dc60d6 Mon Sep 17 00:00:00 2001 From: Pjotr Prins Date: Mon, 5 Oct 2026 07:34:26 +0000 Subject: Rename /dev/token to /get-test-token; require a token everywhere Rename: POST /dev/token -> POST /get-test-token (src/routes/dev.rs, TestToken replacing DevToken), matching tests/get_test_token.rs and test/python/test_get_test_token.py (renamed from tests/dev_token.rs/test_dev_token.py). Config::dev_token_enabled() and the GN_AUTH_DEV_* config keys keep their names -- they're about the dev-token feature generically, not tied to this one route's path. Every endpoint now requires a valid token, not just the dataset_probeset*/traits* family: species(_by_name/_datasets), groups(_by_name/_strains/_traits*/_datasets) and dataset_by_name all gain an AuthToken parameter. /, /version, /openapi.json and /get-test-token itself are the only exceptions -- a health check, a version check, the spec describing all this, and the endpoint that hands out a token in the first place (which would be circular if it needed one). Rather than repeating security(("bearer_token" = [])) on every #[utoipa::path], ApiDoc now declares it once as the document's default security(...), and the three exceptions besides /get-test-token (/, /version) override it with their own empty security() -- standard OpenAPI semantics (an operation's own security, even empty, overrides the document default; an absent one inherits it). error::Unauthorized, a new #[derive(utoipa::IntoResponses)] type wrapping ApiError, is the shared 401 every gated handler now references bare in its own responses(...) list instead of writing out the same (status = 401, description = "...", body = ApiError) tuple by hand. Verified the resolved security per operation in a live /openapi.json. tests/common::auth_token() (Rust) and the new test/python/auth_helpers.auth_token() (Python, deduplicating what four files previously each defined locally) now try this server's own POST /get-test-token first, falling back to GN4_TEST_AUTH_TOKEN -- every previously-ungated test file gains a token check and switches to get_with_token; the whole suite, both languages, now runs with zero manually-provisioned tokens given GENENETWORK4_DEV_MODE=true GENENETWORK4_BIND=127.0.0.1 for the test run. ServerTestCase gains EXTRA_ENV so each Python test class can start its own server with dev mode on. Verified both configured (auto-fetch) and unconfigured (GN4_TEST_AUTH_TOKEN fallback, and full skip when neither is set, e.g. the Guix build sandbox) paths. README.md, docs/gn-auth.md and RELEASE_NOTES.md updated throughout for the rename and the new blanket token requirement. Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01XDDpXvZBQat9uSgDeEMJ8d --- test/python/test_traits.py | 35 ++++++++++------------------------- 1 file changed, 10 insertions(+), 25 deletions(-) (limited to 'test/python/test_traits.py') diff --git a/test/python/test_traits.py b/test/python/test_traits.py index 97603ba..38bf411 100644 --- a/test/python/test_traits.py +++ b/test/python/test_traits.py @@ -1,20 +1,19 @@ """Mirrors tests/traits.rs. Needs a live MariaDB (SQL_URI) and a live -gn-auth (AUTH_SERVER_URL) plus GN4_TEST_AUTH_TOKEN (see -docs/gn-auth.md); skips when any is missing, same as -test_dataset_probeset_info.py. +gn-auth (AUTH_SERVER_URL) plus a token (see docs/gn-auth.md); skips +when any is missing, same as test_dataset_probeset_info.py. +auth_token() tries this server's own POST /get-test-token first +(EXTRA_ENV below makes that possible), falling back to +GN4_TEST_AUTH_TOKEN. """ import http.client import json -import os import socket import unittest -from urllib.parse import urlparse +from auth_helpers import TOKEN_ENV, auth_server_reachable, auth_token from server_test_case import HOST, PORT, ServerTestCase -AUTH_SERVER_URL = os.environ.get("AUTH_SERVER_URL", "http://127.0.0.1:8081/") - def database_reachable(): try: @@ -24,30 +23,16 @@ def database_reachable(): return False -def auth_server_reachable(): - url = urlparse(AUTH_SERVER_URL) - conn = http.client.HTTPConnection(url.hostname, url.port or 80, timeout=2) - try: - conn.request("GET", url.path.rstrip("/") + "/auth/public-jwks") - return conn.getresponse().status == 200 - except OSError: - return False - finally: - conn.close() - - -def auth_token(): - return os.environ.get("GN4_TEST_AUTH_TOKEN") - - class TraitsTest(ServerTestCase): + EXTRA_ENV = TOKEN_ENV + def require_fixtures(self): if not database_reachable(): self.skipTest("no database on 127.0.0.1:3306") if not auth_token(): - self.skipTest("set GN4_TEST_AUTH_TOKEN (see docs/gn-auth.md)") + self.skipTest("no token (see docs/gn-auth.md)") if not auth_server_reachable(): - self.skipTest(f"no gn-auth reachable at {AUTH_SERVER_URL}") + self.skipTest("no gn-auth reachable") def get(self, path, with_token=True): conn = http.client.HTTPConnection(HOST, int(PORT), timeout=10) -- cgit 1.4.1