ClickHouse/tests/integration/test_grpc_protocol_ssl/test.py

122 lines
3.8 KiB
Python
Raw Normal View History

import os
import pytest
import sys
import grpc
2021-01-22 14:27:23 +00:00
from helpers.cluster import ClickHouseCluster, run_and_check
2022-08-09 10:50:28 +00:00
# The test cluster is configured with certificate for that host name, see 'server-ext.cnf'.
# The client have to verify server certificate against that name. Client uses SNI
SSL_HOST = "integration-tests.clickhouse.com"
GRPC_PORT = 9100
SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
DEFAULT_ENCODING = "utf-8"
# Use grpcio-tools to generate *pb2.py files from *.proto.
proto_dir = os.path.join(SCRIPT_DIR, "./protos")
gen_dir = os.path.join(SCRIPT_DIR, "./_gen")
os.makedirs(gen_dir, exist_ok=True)
2021-01-22 14:27:23 +00:00
run_and_check(
"python3 -m grpc_tools.protoc -I{proto_dir} --python_out={gen_dir} --grpc_python_out={gen_dir} \
{proto_dir}/clickhouse_grpc.proto".format(
proto_dir=proto_dir, gen_dir=gen_dir
),
shell=True,
)
sys.path.append(gen_dir)
import clickhouse_grpc_pb2
import clickhouse_grpc_pb2_grpc
# Utilities
config_dir = os.path.join(SCRIPT_DIR, "./configs")
cluster = ClickHouseCluster(__file__)
node = cluster.add_instance(
"node",
main_configs=[
"configs/grpc_config.xml",
"configs/server-key.pem",
"configs/server-cert.pem",
"configs/ca-cert.pem",
],
2022-12-29 19:07:14 +00:00
# Bug in TSAN reproduces in this test https://github.com/grpc/grpc/issues/29550#issuecomment-1188085387
2022-12-29 14:24:23 +00:00
# second_deadlock_stack -- just ordinary option we use everywhere, don't want to overwrite it
env_variables={"TSAN_OPTIONS": "report_atomic_races=0 second_deadlock_stack=1"},
)
def get_grpc_url(instance=node):
return f"{instance.ip_address}:{GRPC_PORT}"
def create_secure_channel():
ca_cert = open(os.path.join(config_dir, "ca-cert.pem"), "rb").read()
client_key = open(os.path.join(config_dir, "client-key.pem"), "rb").read()
client_cert = open(os.path.join(config_dir, "client-cert.pem"), "rb").read()
credentials = grpc.ssl_channel_credentials(ca_cert, client_key, client_cert)
channel = grpc.secure_channel(
get_grpc_url(),
credentials,
options=(("grpc.ssl_target_name_override", SSL_HOST),),
)
grpc.channel_ready_future(channel).result(timeout=10)
return channel
def create_insecure_channel():
channel = grpc.insecure_channel(get_grpc_url())
grpc.channel_ready_future(channel).result(timeout=2)
return channel
def create_secure_channel_with_wrong_client_certificate():
ca_cert = open(os.path.join(config_dir, "ca-cert.pem"), "rb").read()
client_key = open(os.path.join(config_dir, "wrong-client-key.pem"), "rb").read()
client_cert = open(os.path.join(config_dir, "wrong-client-cert.pem"), "rb").read()
credentials = grpc.ssl_channel_credentials(ca_cert, client_key, client_cert)
channel = grpc.secure_channel(get_grpc_url(), credentials)
grpc.channel_ready_future(channel).result(timeout=2)
return channel
def query(query_text, channel):
query_info = clickhouse_grpc_pb2.QueryInfo(query=query_text)
stub = clickhouse_grpc_pb2_grpc.ClickHouseStub(channel)
result = stub.ExecuteQuery(query_info)
if result and result.HasField("exception"):
raise Exception(result.exception.display_text)
return result.output.decode(DEFAULT_ENCODING)
@pytest.fixture(scope="module", autouse=True)
def start_cluster():
cluster.start()
try:
yield cluster
finally:
cluster.shutdown()
# Actual tests
def test_secure_channel():
with create_secure_channel() as channel:
assert query("SELECT 'ok'", channel) == "ok\n"
def test_insecure_channel():
with pytest.raises(grpc.FutureTimeoutError):
with create_insecure_channel() as channel:
query("SELECT 'ok'", channel)
def test_wrong_client_certificate():
with pytest.raises(grpc.FutureTimeoutError):
with create_insecure_channel() as channel:
query("SELECT 'ok'", channel)