about summary refs log tree commit diff
path: root/test/python/auth_helpers.py
diff options
context:
space:
mode:
authorPjotr Prins <pjotr.public01@thebird.nl>2026-10-05 07:34:26 +0000
committerPjotr <wrk@bosa.lan>2026-10-05 07:34:26 +0000
commit649ff6395bdca06530ceabd3e216c66851dc60d6 (patch)
tree2bbe7008a8258b11ada120315fedff208d230206 /test/python/auth_helpers.py
parent693e7ee89f8618c1abbf8af5c0db23b071700803 (diff)
downloadgenenetwork4-649ff6395bdca06530ceabd3e216c66851dc60d6.tar.gz
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 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XDDpXvZBQat9uSgDeEMJ8d
Diffstat (limited to 'test/python/auth_helpers.py')
-rw-r--r--test/python/auth_helpers.py58
1 files changed, 58 insertions, 0 deletions
diff --git a/test/python/auth_helpers.py b/test/python/auth_helpers.py
new file mode 100644
index 0000000..8b3e80d
--- /dev/null
+++ b/test/python/auth_helpers.py
@@ -0,0 +1,58 @@
+"""Shared helpers for tests that need a gn-auth bearer token. Mirrors
+tests/common/mod.rs's auth_token()/auth_server_available() on the Rust
+side.
+
+A test class that uses auth_token() must set EXTRA_ENV = TOKEN_ENV (see
+server_test_case.py) so its own spawned server can answer
+POST /get-test-token (src/routes/dev.rs) with a real one.
+"""
+
+import http.client
+import json
+import os
+from urllib.parse import urlparse
+
+from server_test_case import HOST, PORT
+
+AUTH_SERVER_URL = os.environ.get("AUTH_SERVER_URL", "http://127.0.0.1:8081/")
+
+# Every endpoint needs a token now (see docs/gn-auth.md) -- a test class
+# that calls auth_token() needs its server started with this so it can
+# self-issue one.
+TOKEN_ENV = {"GENENETWORK4_DEV_MODE": "true", "GENENETWORK4_BIND": "127.0.0.1"}
+
+
+def auth_server_reachable():
+    """True only when gn-auth is actually reachable at AUTH_SERVER_URL."""
+    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():
+    """A bearer token to use against the already-running test server
+    (started with TOKEN_ENV). Tries POST /get-test-token first -- this
+    just works once the server was started with TOKEN_ENV, no
+    externally managed token needed -- falling back to the
+    GN4_TEST_AUTH_TOKEN env var (see docs/gn-auth.md) for a gn-auth
+    setup that doesn't want dev mode on even for tests. Returns None,
+    rather than raising, if neither produces a token; callers should
+    skipTest() in that case.
+    """
+    conn = http.client.HTTPConnection(HOST, int(PORT), timeout=10)
+    try:
+        conn.request("POST", "/get-test-token")
+        response = conn.getresponse()
+        if response.status == 200:
+            return json.loads(response.read())["access_token"]
+    except OSError:
+        pass
+    finally:
+        conn.close()
+    return os.environ.get("GN4_TEST_AUTH_TOKEN")