about summary refs log tree commit diff
path: root/test/python
diff options
context:
space:
mode:
authorPjotr Prins <pjotr.public01@thebird.nl>2026-10-04 14:38:12 +0000
committerPjotr <wrk@bosa.lan>2026-10-04 14:38:12 +0000
commit5e7870834fc29e707bc7332d83e4c68f05b9b8f7 (patch)
tree1fb4e1724a0daa968dafb6d301276c73ad8d3c5d /test/python
parent21c69c1051715e6964fe9d4c8e06a326344fe6eb (diff)
downloadgenenetwork4-5e7870834fc29e707bc7332d83e4c68f05b9b8f7.tar.gz
Add GET /groups/{group}/traits and GET /datasets/{dataset}/probesets
List endpoints for the two trait domains, each the listing equivalent
of an existing singular endpoint:

- GET /groups/{group}/traits: every published (phenotype) trait in a
  group (db::get_group_traits), same fields/join as
  /groups/{group}/traits/{trait_id}, no token required -- matching its
  singular sibling, which isn't gated either. A large group (BXD has
  15000+ phenotype traits) can take several seconds and tens of
  megabytes to return in full; no pagination yet, matching
  GeneNetwork2's own wqflask.api.router.fetch_traits, which has no
  default limit either.

- GET /datasets/{dataset}/probesets: every expression (ProbeSet) trait
  in a dataset (db::get_dataset_probesets), same fields/join as
  /datasets/{dataset}/probesets/{probeset}. Gated the same way as that
  singular endpoint -- a valid token is required unconditionally, and
  a non-public dataset is checked against gn-auth once for the whole
  dataset via a new auth::authorise_dataset, rather than once per
  probeset in the list. Leaving this listing ungated would have let a
  caller read out a whole non-public dataset's trait data in one
  request, bypassing the gate just added to the singular endpoint.

auth::authorise_dataset wraps authorise_trait with an empty trait
name: gn-auth resolves a trait's resource purely from its dataset
name, so the trait half of a "Dataset::Trait" string never affects
which privileges come back. Verified directly against the live
instance both for an unlinked non-public dataset (403, deny) and
folded into dataset_probesets's own test for the public/embargo-aged
bypass path.

tests/group_traits.rs, tests/dataset_probesets.rs and their Python
mirrors cover both, run against a real gn-auth instance for the gated
one.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XDDpXvZBQat9uSgDeEMJ8d
Diffstat (limited to 'test/python')
-rw-r--r--test/python/test_dataset_probesets.py109
-rw-r--r--test/python/test_group_traits.py65
2 files changed, 174 insertions, 0 deletions
diff --git a/test/python/test_dataset_probesets.py b/test/python/test_dataset_probesets.py
new file mode 100644
index 0000000..64cebff
--- /dev/null
+++ b/test/python/test_dataset_probesets.py
@@ -0,0 +1,109 @@
+"""Mirrors tests/dataset_probesets.rs. Needs a live MariaDB (SQL_URI);
+skips with a message rather than failing when none is reachable, same
+as test_group_by_name.py. Also needs a live gn-auth (AUTH_SERVER_URL)
+and GN4_TEST_AUTH_TOKEN (see docs/gn-auth.md), since this endpoint now
+requires a bearer token; skips when either is missing.
+"""
+
+import http.client
+import json
+import os
+import socket
+import unittest
+from urllib.parse import urlparse
+
+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:
+        with socket.create_connection(("127.0.0.1", 3306), timeout=0.5):
+            return True
+    except OSError:
+        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 DatasetProbesetsTest(ServerTestCase):
+    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)")
+        if not auth_server_reachable():
+            self.skipTest(f"no gn-auth reachable at {AUTH_SERVER_URL}")
+
+    def get(self, path, with_token=True):
+        conn = http.client.HTTPConnection(HOST, int(PORT), timeout=10)
+        try:
+            headers = {"Authorization": f"Bearer {auth_token()}"} if with_token else {}
+            conn.request("GET", path, headers=headers)
+            response = conn.getresponse()
+            return response, response.read()
+        finally:
+            conn.close()
+
+    def test_dataset_probesets_returns_probesets(self):
+        self.require_fixtures()
+
+        response, body = self.get("/datasets/Br_U_0803_M/probesets")
+        self.assertEqual(response.status, 200)
+
+        probesets = json.loads(body)
+        self.assertTrue(probesets)
+        names = {record["name"] for record in probesets}
+        self.assertIn("100001_at", names)
+
+    def test_dataset_probesets_without_a_token_returns_401(self):
+        if not database_reachable():
+            self.skipTest("no database on 127.0.0.1:3306")
+
+        response, _body = self.get("/datasets/Br_U_0803_M/probesets", with_token=False)
+        self.assertEqual(response.status, 401)
+
+    def test_dataset_probesets_unknown_dataset_returns_404(self):
+        self.require_fixtures()
+
+        response, body = self.get("/datasets/not-a-real-dataset/probesets")
+        self.assertEqual(response.status, 404)
+
+        error = json.loads(body)
+        self.assertEqual(error["status"], 404)
+        self.assertEqual(error["code"], "dataset_not_found")
+        self.assertEqual(error["operation_id"], "dataset_probesets")
+
+    def test_dataset_probesets_non_public_unlinked_dataset_returns_403(self):
+        """UTHSC_BXD_Cochlea_0225 (public=1, confidentiality=1, created
+        2025-02-13) is neither publicly readable by the flags nor old
+        enough for the embargo-age rule, and has never been linked to a
+        gn-auth resource -- so even the token's owner has no privilege
+        on it.
+        """
+        self.require_fixtures()
+
+        response, body = self.get("/datasets/UTHSC_BXD_Cochlea_0225/probesets")
+        self.assertEqual(response.status, 403)
+
+        error = json.loads(body)
+        self.assertEqual(error["code"], "forbidden")
+
+
+if __name__ == "__main__":
+    unittest.main()
diff --git a/test/python/test_group_traits.py b/test/python/test_group_traits.py
new file mode 100644
index 0000000..e414e7e
--- /dev/null
+++ b/test/python/test_group_traits.py
@@ -0,0 +1,65 @@
+"""Mirrors tests/group_traits.rs. Needs a live MariaDB (SQL_URI);
+skips with a message rather than failing when none is reachable, same as
+test_group_by_name.py.
+"""
+
+import http.client
+import json
+import socket
+import unittest
+
+from server_test_case import HOST, PORT, ServerTestCase
+
+
+def database_reachable():
+    try:
+        with socket.create_connection(("127.0.0.1", 3306), timeout=0.5):
+            return True
+    except OSError:
+        return False
+
+
+class GroupTraitsTest(ServerTestCase):
+    def test_group_traits_bxd_returns_traits(self):
+        if not database_reachable():
+            self.skipTest("no database on 127.0.0.1:3306")
+
+        # BXD alone has 15000+ phenotype traits (a ~17MB response);
+        # fetching all of them can take longer than the default 10s
+        # used elsewhere in this test suite.
+        conn = http.client.HTTPConnection(HOST, int(PORT), timeout=30)
+        try:
+            conn.request("GET", "/groups/BXD/traits")
+            response = conn.getresponse()
+            body = response.read()
+        finally:
+            conn.close()
+        self.assertEqual(response.status, 200)
+
+        traits = json.loads(body)
+        self.assertTrue(traits)
+        ids = {record["id"] for record in traits}
+        self.assertIn(10001, ids)
+
+    def test_group_traits_unknown_group_returns_404(self):
+        if not database_reachable():
+            self.skipTest("no database on 127.0.0.1:3306")
+
+        conn = http.client.HTTPConnection(HOST, int(PORT), timeout=10)
+        try:
+            conn.request("GET", "/groups/not-a-real-group/traits")
+            response = conn.getresponse()
+            body = response.read()
+        finally:
+            conn.close()
+        self.assertEqual(response.status, 404)
+
+        error = json.loads(body)
+        self.assertEqual(error["status"], 404)
+        self.assertEqual(error["code"], "group_not_found")
+        self.assertEqual(error["operation_id"], "group_traits")
+        self.assertEqual(error["next"], "/groups")
+
+
+if __name__ == "__main__":
+    unittest.main()