about summary refs log tree commit diff
path: root/test/python/test_group_case_attributes.py
blob: 30c717c2b02211909fa2ca21040e05970b073b41 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
"""Mirrors tests/group_case_attributes.rs. Needs a live MariaDB
(SQL_URI, see src/db.rs) and a valid token (every endpoint needs one
now -- see docs/gn-auth.md); skips rather than fails 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 GroupCaseAttributesTest(ServerTestCase):
    EXTRA_ENV = TOKEN_ENV

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

    def test_group_case_attributes_bxd_returns_names_and_values(self):
        """BXD (InbredSetId 1) has exactly 4 case attributes -- Epoch,
        RRID, SeqCvge, Status -- each strain in the response should have
        exactly those 4 keys, not more (CaseAttributeId isn't unique
        across groups -- see the comment in src/db.rs -- so getting the
        join wrong would pull in unrelated groups' attributes too).
        """
        if not database_reachable():
            self.skipTest("no database on 127.0.0.1:3306")

        response, body = self.get("/groups/BXD/case-attributes")
        self.assertEqual(response.status, 200)

        case_attributes = envelope_data(body)
        self.assertEqual(
            case_attributes["names"], ["Epoch", "RRID", "SeqCvge", "Status"]
        )

        values = case_attributes["values"]
        self.assertTrue(values)
        bxd1 = next(v for v in values if v["strain"] == "BXD1")
        self.assertEqual(
            set(bxd1["case_attributes"].keys()), set(case_attributes["names"])
        )

    def test_group_case_attributes_group_with_none_returns_empty(self):
        """LXS (InbredSetId 9) is a real group with no case attributes
        defined at all -- an empty result, not a 404 (the group itself
        exists)."""
        if not database_reachable():
            self.skipTest("no database on 127.0.0.1:3306")

        response, body = self.get("/groups/LXS/case-attributes")
        self.assertEqual(response.status, 200)

        case_attributes = envelope_data(body)
        self.assertEqual(case_attributes["names"], [])
        self.assertEqual(case_attributes["values"], [])

    def test_group_case_attributes_without_a_token_returns_401(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/BXD/case-attributes")
            response = conn.getresponse()
        finally:
            conn.close()
        self.assertEqual(response.status, 401)

    def test_group_case_attributes_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/case-attributes")
        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_case_attributes")
        self.assertEqual(error["next"], "/groups")


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