|
1 | 1 | import unittest |
| 2 | +import struct |
2 | 3 | from unittest.mock import Mock, patch, ANY |
3 | 4 |
|
4 | | -from pyarrow.flight import Ticket |
| 5 | +from pyarrow import ( |
| 6 | + array, |
| 7 | + Table |
| 8 | +) |
| 9 | + |
| 10 | +from pyarrow.flight import ( |
| 11 | + FlightServerBase, |
| 12 | + FlightUnauthenticatedError, |
| 13 | + GeneratorStream, |
| 14 | + ServerMiddleware, |
| 15 | + ServerMiddlewareFactory, |
| 16 | + ServerAuthHandler, |
| 17 | + Ticket |
| 18 | +) |
5 | 19 |
|
6 | 20 | from influxdb_client_3 import InfluxDBClient3 |
| 21 | +from influxdb_client_3.version import USER_AGENT |
| 22 | + |
| 23 | + |
| 24 | +def case_insensitive_header_lookup(headers, lkey): |
| 25 | + """Lookup the value of a given key in the given headers. |
| 26 | + The lkey is case-insensitive. |
| 27 | + """ |
| 28 | + for key in headers: |
| 29 | + if key.lower() == lkey.lower(): |
| 30 | + return headers.get(key) |
| 31 | + |
| 32 | + |
| 33 | +class NoopAuthHandler(ServerAuthHandler): |
| 34 | + """A no-op auth handler - as seen in pyarrow tests""" |
| 35 | + |
| 36 | + def authenticate(self, outgoing, incoming): |
| 37 | + """Do nothing""" |
| 38 | + |
| 39 | + def is_valid(self, token): |
| 40 | + """ |
| 41 | + Return an empty string |
| 42 | + N.B. Returning None causes Type error |
| 43 | + :param token: |
| 44 | + :return: |
| 45 | + """ |
| 46 | + return "" |
| 47 | + |
| 48 | + |
| 49 | +_req_headers = {} |
| 50 | + |
| 51 | + |
| 52 | +class HeaderCheckServerMiddlewareFactory(ServerMiddlewareFactory): |
| 53 | + """Factory to create HeaderCheckServerMiddleware and check header values""" |
| 54 | + def start_call(self, info, headers): |
| 55 | + auth_header = case_insensitive_header_lookup(headers, "Authorization") |
| 56 | + values = auth_header[0].split(' ') |
| 57 | + if values[0] != 'Bearer': |
| 58 | + raise FlightUnauthenticatedError("Token required") |
| 59 | + global _req_headers |
| 60 | + _req_headers = headers |
| 61 | + return HeaderCheckServerMiddleware(values[1]) |
| 62 | + |
| 63 | + |
| 64 | +class HeaderCheckServerMiddleware(ServerMiddleware): |
| 65 | + """ |
| 66 | + Middleware needed to catch request headers via factory |
| 67 | + N.B. As found in pyarrow tests |
| 68 | + """ |
| 69 | + def __init__(self, token): |
| 70 | + self.token = token |
| 71 | + |
| 72 | + def sending_headers(self): |
| 73 | + return {'authorization': 'Bearer ' + self.token} |
| 74 | + |
| 75 | + |
| 76 | +class HeaderCheckFlightServer(FlightServerBase): |
| 77 | + """Mock server handle gRPC do_get calls""" |
| 78 | + def do_get(self, context, ticket): |
| 79 | + """Return something to avoid needless errors""" |
| 80 | + data = [ |
| 81 | + array([b"Vltava", struct.pack('<i', 105), b"FM"]) |
| 82 | + ] |
| 83 | + table = Table.from_arrays(data, names=['a']) |
| 84 | + return GeneratorStream( |
| 85 | + table.schema, |
| 86 | + self.number_batches(table), |
| 87 | + options={}) |
| 88 | + |
| 89 | + @staticmethod |
| 90 | + def number_batches(table): |
| 91 | + for idx, batch in enumerate(table.to_batches()): |
| 92 | + buf = struct.pack('<i', idx) |
| 93 | + yield batch, buf |
| 94 | + |
| 95 | + |
| 96 | +def test_influx_default_query_headers(): |
| 97 | + with HeaderCheckFlightServer( |
| 98 | + auth_handler=NoopAuthHandler(), |
| 99 | + middleware={"check": HeaderCheckServerMiddlewareFactory()}) as server: |
| 100 | + global _req_headers |
| 101 | + _req_headers = {} |
| 102 | + client = InfluxDBClient3( |
| 103 | + host=f'http://localhost:{server.port}', |
| 104 | + org='test_org', |
| 105 | + databse='test_db', |
| 106 | + token='TEST_TOKEN' |
| 107 | + ) |
| 108 | + client.query('SELECT * FROM test') |
| 109 | + assert len(_req_headers) > 0 |
| 110 | + assert _req_headers['authorization'][0] == "Bearer TEST_TOKEN" |
| 111 | + assert _req_headers['user-agent'][0].find(USER_AGENT) > -1 |
| 112 | + _req_headers = {} |
7 | 113 |
|
8 | 114 |
|
9 | 115 | class QueryTests(unittest.TestCase): |
|
0 commit comments