about summary refs log tree commit diff
path: root/test/python/test_search.py
blob: d8c5cc5ec6ddc8553ec1ef7d57fa911fb50da5fa (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
"""Mirrors tests/search.rs. Spawns the real binary plus a local gn3 stub
(HTTP server serving the recorded fixture), so no external network is
needed; runs in the Guix sandbox.
"""

import http.client
import http.server
import json
import os
import threading
import unittest
import urllib.parse

from server_test_case import HOST, PORT, ServerTestCase, wait_for_port

FIXTURE = os.path.join(
    os.path.dirname(__file__), "..", "data", "search_alcohol_phenotype.json"
)


class Gn3StubHandler(http.server.BaseHTTPRequestHandler):
    """Stands in for gn3's /api/search during tests."""

    def do_GET(self):
        query = urllib.parse.parse_qs(urllib.parse.urlparse(self.path).query)
        if "&&" in query.get("query", [""])[0]:
            # Mirrors production gn3's shape (live-checked Oct 4):
            # diagnostic under "error", Python repr under "error_type".
            body = json.dumps(
                {
                    "error": "Syntax: <expression> AND <expression>",
                    "error_type": "b'QueryParserError'",
                }
            ).encode()
            self.send_response(http.client.BAD_REQUEST)
        else:
            with open(FIXTURE, "rb") as fixture:
                body = fixture.read()
            self.send_response(http.client.OK)
        self.send_header("Content-Type", "application/json")
        self.send_header("Content-Length", str(len(body)))
        self.end_headers()
        self.wfile.write(body)

    def log_message(self, *args):
        pass


class SearchTest(ServerTestCase):
    @classmethod
    def setUpClass(cls):
        cls.stub = http.server.ThreadingHTTPServer(
            (HOST, 0), Gn3StubHandler
        )
        stub_port = cls.stub.server_address[1]
        threading.Thread(target=cls.stub.serve_forever, daemon=True).start()
        os.environ["GN3_URL"] = f"http://127.0.0.1:{stub_port}/api/"
        super().setUpClass()

    @classmethod
    def tearDownClass(cls):
        super().tearDownClass()
        cls.stub.shutdown()

    def get(self, uri):
        conn = http.client.HTTPConnection(HOST, int(PORT), timeout=10)
        try:
            conn.request("GET", uri)
            response = conn.getresponse()
            return response.status, json.loads(response.read())
        finally:
            conn.close()

    def test_search_wraps_gn3_hits_in_envelope(self):
        status, body = self.get("/search?q=alcohol&type=phenotype&limit=5")
        self.assertEqual(status, http.client.OK)
        hits = body["data"]
        self.assertEqual(len(hits), 5)
        self.assertEqual(hits[0]["name"], "10199")
        self.assertEqual(hits[0]["dataset"], "C57BL-6JxC57BL-6NJF2Publish")
        self.assertEqual(body["next"], [])

    def test_search_validates_parameters(self):
        status, body = self.get("/search?q=%20%20")
        self.assertEqual(status, http.client.BAD_REQUEST)
        self.assertEqual(body["code"], "invalid_parameter")

        status, body = self.get("/search?q=alcohol&type=genotype")
        self.assertEqual(status, http.client.BAD_REQUEST)
        self.assertIn("phenotype", body["detail"])

    def test_search_forwards_gn3_parse_errors(self):
        status, body = self.get("/search?q=a%26%26b")
        self.assertEqual(status, http.client.UNPROCESSABLE_ENTITY)
        self.assertEqual(body["code"], "invalid_query")
        self.assertIn("Syntax: <expression> AND <expression>", body["detail"])

    def test_search_caps_limit(self):
        status, _ = self.get("/search?q=alcohol&limit=9999")
        self.assertEqual(status, http.client.OK)


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