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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
|
import ssl
from clickhouse_driver import Client
from clickhouse_driver.compression.lz4 import Compressor as LZ4Compressor
from clickhouse_driver.compression.lz4hc import Compressor as LZHC4Compressor
from clickhouse_driver.compression.zstd import Compressor as ZSTDCompressor
from clickhouse_driver.protocol import Compression
from tests.numpy.util import check_numpy
from tests.testcase import TestCase
class ClientFromUrlTestCase(TestCase):
def assertHostsEqual(self, client, another, msg=None):
self.assertEqual(list(client.connection.hosts), another, msg=msg)
def test_simple(self):
c = Client.from_url('clickhouse://host')
self.assertHostsEqual(c, [('host', 9000)])
self.assertEqual(c.connection.database, '')
c = Client.from_url('clickhouse://host/db')
self.assertHostsEqual(c, [('host', 9000)])
self.assertEqual(c.connection.database, 'db')
def test_credentials(self):
c = Client.from_url('clickhouse://host/db')
self.assertEqual(c.connection.user, 'default')
self.assertEqual(c.connection.password, '')
c = Client.from_url('clickhouse://admin:secure@host/db')
self.assertEqual(c.connection.user, 'admin')
self.assertEqual(c.connection.password, 'secure')
c = Client.from_url('clickhouse://user:@host/db')
self.assertEqual(c.connection.user, 'user')
self.assertEqual(c.connection.password, '')
def test_credentials_unquoting(self):
c = Client.from_url('clickhouse://ad%3Amin:se%2Fcure@host/db')
self.assertEqual(c.connection.user, 'ad:min')
self.assertEqual(c.connection.password, 'se/cure')
def test_schema(self):
c = Client.from_url('clickhouse://host')
self.assertFalse(c.connection.secure_socket)
c = Client.from_url('clickhouses://host')
self.assertTrue(c.connection.secure_socket)
c = Client.from_url('test://host')
self.assertFalse(c.connection.secure_socket)
def test_port(self):
c = Client.from_url('clickhouse://host')
self.assertHostsEqual(c, [('host', 9000)])
c = Client.from_url('clickhouses://host')
self.assertHostsEqual(c, [('host', 9440)])
c = Client.from_url('clickhouses://host:1234')
self.assertHostsEqual(c, [('host', 1234)])
def test_secure(self):
c = Client.from_url('clickhouse://host?secure=n')
self.assertHostsEqual(c, [('host', 9000)])
self.assertFalse(c.connection.secure_socket)
c = Client.from_url('clickhouse://host?secure=y')
self.assertHostsEqual(c, [('host', 9440)])
self.assertTrue(c.connection.secure_socket)
c = Client.from_url('clickhouse://host:1234?secure=y')
self.assertHostsEqual(c, [('host', 1234)])
self.assertTrue(c.connection.secure_socket)
with self.assertRaises(ValueError):
Client.from_url('clickhouse://host:1234?secure=nonono')
def test_compression(self):
c = Client.from_url('clickhouse://host?compression=n')
self.assertEqual(c.connection.compression, Compression.DISABLED)
self.assertIsNone(c.connection.compressor_cls)
c = Client.from_url('clickhouse://host?compression=y')
self.assertEqual(c.connection.compression, Compression.ENABLED)
self.assertIs(c.connection.compressor_cls, LZ4Compressor)
c = Client.from_url('clickhouse://host?compression=lz4')
self.assertEqual(c.connection.compression, Compression.ENABLED)
self.assertIs(c.connection.compressor_cls, LZ4Compressor)
c = Client.from_url('clickhouse://host?compression=lz4hc')
self.assertEqual(c.connection.compression, Compression.ENABLED)
self.assertIs(c.connection.compressor_cls, LZHC4Compressor)
c = Client.from_url('clickhouse://host?compression=zstd')
self.assertEqual(c.connection.compression, Compression.ENABLED)
self.assertIs(c.connection.compressor_cls, ZSTDCompressor)
with self.assertRaises(ValueError):
Client.from_url('clickhouse://host:1234?compression=custom')
def test_client_name(self):
c = Client.from_url('clickhouse://host?client_name=native')
self.assertEqual(c.connection.client_name, 'ClickHouse native')
def test_timeouts(self):
with self.assertRaises(ValueError):
Client.from_url('clickhouse://host?connect_timeout=test')
c = Client.from_url('clickhouse://host?connect_timeout=1.2')
self.assertEqual(c.connection.connect_timeout, 1.2)
c = Client.from_url('clickhouse://host?send_receive_timeout=1.2')
self.assertEqual(c.connection.send_receive_timeout, 1.2)
c = Client.from_url('clickhouse://host?sync_request_timeout=1.2')
self.assertEqual(c.connection.sync_request_timeout, 1.2)
def test_compress_block_size(self):
with self.assertRaises(ValueError):
Client.from_url('clickhouse://host?compress_block_size=test')
c = Client.from_url('clickhouse://host?compress_block_size=100500')
# compression is not set
self.assertIsNone(c.connection.compress_block_size)
c = Client.from_url(
'clickhouse://host?'
'compress_block_size=100500&'
'compression=1'
)
self.assertEqual(c.connection.compress_block_size, 100500)
def test_settings(self):
c = Client.from_url(
'clickhouse://host?'
'send_logs_level=trace&'
'max_block_size=123'
)
self.assertEqual(c.settings, {
'send_logs_level': 'trace',
'max_block_size': '123'
})
def test_ssl(self):
c = Client.from_url(
'clickhouses://host?'
'verify=false&'
'ssl_version=PROTOCOL_SSLv23&'
'ca_certs=/tmp/certs&'
'ciphers=HIGH:-aNULL:-eNULL:-PSK:RC4-SHA:RC4-MD5'
)
self.assertEqual(c.connection.ssl_options, {
'ssl_version': ssl.PROTOCOL_SSLv23,
'ca_certs': '/tmp/certs',
'ciphers': 'HIGH:-aNULL:-eNULL:-PSK:RC4-SHA:RC4-MD5'
})
def test_ssl_key_cert(self):
base_url = (
'clickhouses://host?'
'verify=true&'
'ssl_version=PROTOCOL_SSLv23&'
'ca_certs=/tmp/certs&'
'ciphers=HIGH:-aNULL:-eNULL:-PSK:RC4-SHA:RC4-MD5&'
)
base_expected = {
'ssl_version': ssl.PROTOCOL_SSLv23,
'ca_certs': '/tmp/certs',
'ciphers': 'HIGH:-aNULL:-eNULL:-PSK:RC4-SHA:RC4-MD5'
}
c = Client.from_url(
base_url +
'keyfile=/tmp/client.key&'
'certfile=/tmp/client.cert'
)
expected = base_expected.copy()
expected.update({
'keyfile': '/tmp/client.key',
'certfile': '/tmp/client.cert'
})
self.assertEqual(c.connection.ssl_options, expected)
c = Client.from_url(
base_url +
'certfile=/tmp/client.cert'
)
expected = base_expected.copy()
expected.update({
'certfile': '/tmp/client.cert'
})
self.assertEqual(c.connection.ssl_options, expected)
def test_alt_hosts(self):
c = Client.from_url('clickhouse://host?alt_hosts=host2:1234')
self.assertHostsEqual(c, [('host', 9000), ('host2', 1234)])
c = Client.from_url('clickhouse://host?alt_hosts=host2')
self.assertHostsEqual(c, [('host', 9000), ('host2', 9000)])
def test_parameters_cast(self):
c = Client.from_url('clickhouse://host?insert_block_size=123')
self.assertEqual(
c.connection.context.client_settings['insert_block_size'], 123
)
def test_settings_is_important(self):
c = Client.from_url('clickhouse://host?settings_is_important=1')
self.assertEqual(c.connection.settings_is_important, True)
with self.assertRaises(ValueError):
c = Client.from_url('clickhouse://host?settings_is_important=2')
self.assertEqual(c.connection.settings_is_important, True)
c = Client.from_url('clickhouse://host?settings_is_important=0')
self.assertEqual(c.connection.settings_is_important, False)
@check_numpy
def test_use_numpy(self):
c = Client.from_url('clickhouse://host?use_numpy=true')
self.assertTrue(c.connection.context.client_settings['use_numpy'])
def test_opentelemetry(self):
c = Client.from_url(
'clickhouse://host?opentelemetry_traceparent='
'00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-00'
)
self.assertEqual(
c.connection.context.client_settings['opentelemetry_traceparent'],
'00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-00'
)
self.assertEqual(
c.connection.context.client_settings['opentelemetry_tracestate'],
''
)
c = Client.from_url(
'clickhouse://host?opentelemetry_traceparent='
'00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-00&'
'opentelemetry_tracestate=state'
)
self.assertEqual(
c.connection.context.client_settings['opentelemetry_traceparent'],
'00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-00'
)
self.assertEqual(
c.connection.context.client_settings['opentelemetry_tracestate'],
'state'
)
def test_quota_key(self):
c = Client.from_url('clickhouse://host?quota_key=myquota')
self.assertEqual(
c.connection.context.client_settings['quota_key'], 'myquota'
)
c = Client.from_url('clickhouse://host')
self.assertEqual(
c.connection.context.client_settings['quota_key'], ''
)
def test_round_robin(self):
c = Client.from_url('clickhouse://host?alt_hosts=host2')
self.assertEqual(len(c.connections), 0)
c = Client.from_url(
'clickhouse://host?round_robin=true&alt_hosts=host2'
)
self.assertEqual(len(c.connections), 1)
|