about summary refs log tree commit diff
path: root/test/python/test_group_traits.py
blob: 72abcba7937e96fbbd7650449214199b76c289d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
"""Mirrors tests/group_traits.rs. Needs a live MariaDB (SQL_URI) and a
valid token (every endpoint needs one now -- see docs/gn-auth.md);
skips with a message rather than failing when either is missing, same
as test_group_by_name.py.
"""

import http.client
import json
import socket
import unittest

from auth_helpers import TOKEN_ENV, auth_token
from server_test_case import HOST, PORT, ServerTestCase, envelope_data


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):
    EXTRA_ENV = TOKEN_ENV

    def get(self, path, timeout=10):
        token = auth_token()
        if not token:
            self.skipTest("no token (see docs/gn-auth.md)")
        conn = http.client.HTTPConnection(HOST, int(PORT), timeout=timeout)
        try:
            conn.request("GET", path, headers={"Authorization": f"Bearer {token}"})
            response = conn.getresponse()
            return response, response.read()
        finally:
            conn.close()

    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.
        response, body = self.get("/groups/BXD/traits", timeout=30)
        self.assertEqual(response.status, 200)

        traits = envelope_data(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")

        response, body = self.get("/groups/not-a-real-group/traits")
        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")

    def test_group_traits_filters_by_abbreviation(self):
        if not database_reachable():
            self.skipTest("no database on 127.0.0.1:3306")

        response, body = self.get("/groups/BXD/traits?abbreviation=5HT_MB_M")
        self.assertEqual(response.status, 200)
        traits = envelope_data(body)
        self.assertEqual(len(traits), 1)
        self.assertEqual(traits[0]["id"], 17985)
        self.assertEqual(traits[0]["abbreviation"], "5HT_MB_M")
        self.assertEqual(traits[0]["dataset"], "BXDPublish")
        self.assertEqual(
            traits[0]["url"],
            "https://genenetwork.org/show_trait?trait_id=17985&dataset=BXDPublish",
        )

        # An unknown abbreviation is an empty list, not an error.
        response, body = self.get("/groups/BXD/traits?abbreviation=no_such_trait")
        self.assertEqual(response.status, 200)
        self.assertEqual(envelope_data(body), [])


if __name__ == "__main__":
    unittest.main()