mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-13 18:02:24 +00:00
60c049375c
This will allow to omit them in requests for dynamic_query_handler/predefined_query_handler, that will allow to build more indepenent handlers/apps. Signed-off-by: Azat Khuzhin <a.khuzhin@semrush.com>
627 lines
19 KiB
Python
627 lines
19 KiB
Python
import contextlib
|
|
import os
|
|
import urllib.error
|
|
import urllib.parse
|
|
import urllib.request
|
|
|
|
from helpers.cluster import ClickHouseCluster
|
|
|
|
|
|
class SimpleCluster:
|
|
def close(self):
|
|
self.cluster.shutdown()
|
|
|
|
def __init__(self, cluster, name, config_dir):
|
|
self.cluster = cluster
|
|
self.instance = self.add_instance(name, config_dir)
|
|
cluster.start()
|
|
|
|
def add_instance(self, name, config_dir):
|
|
return self.cluster.add_instance(
|
|
name,
|
|
main_configs=[os.path.join(config_dir, "config.xml")],
|
|
user_configs=["users.d/users.yaml"],
|
|
)
|
|
|
|
|
|
def test_dynamic_query_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "dynamic_handler", "test_dynamic_handler"
|
|
)
|
|
) as cluster:
|
|
test_query = urllib.parse.quote_plus(
|
|
"SELECT * FROM system.settings WHERE name = 'max_threads'"
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"?max_threads=1", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_dynamic_handler_get?max_threads=1",
|
|
method="POST",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_dynamic_handler_get?max_threads=1",
|
|
method="GET",
|
|
headers={"XXX": "bad"},
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
400
|
|
== cluster.instance.http_request(
|
|
"test_dynamic_handler_get?max_threads=1",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
|
|
res_default = cluster.instance.http_request(
|
|
"test_dynamic_handler_get?max_threads=1&get_dynamic_handler_query="
|
|
+ test_query,
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
)
|
|
assert 200 == res_default.status_code
|
|
assert (
|
|
"text/tab-separated-values; charset=UTF-8"
|
|
== res_default.headers["content-type"]
|
|
)
|
|
|
|
res_custom_ct = cluster.instance.http_request(
|
|
"test_dynamic_handler_get_custom_content_type?max_threads=1&get_dynamic_handler_query="
|
|
+ test_query,
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
)
|
|
assert 200 == res_custom_ct.status_code
|
|
assert (
|
|
"application/whatever; charset=cp1337"
|
|
== res_custom_ct.headers["content-type"]
|
|
)
|
|
assert "it works" == res_custom_ct.headers["X-Test-Http-Response-Headers-Works"]
|
|
assert (
|
|
"also works"
|
|
== res_custom_ct.headers["X-Test-Http-Response-Headers-Even-Multiple"]
|
|
)
|
|
|
|
assert cluster.instance.http_request(
|
|
"test_dynamic_handler_auth_with_password?query=select+currentUser()"
|
|
).content, "with_password"
|
|
assert cluster.instance.http_request(
|
|
"test_dynamic_handler_auth_with_password_fail?query=select+currentUser()"
|
|
).status_code, 403
|
|
assert cluster.instance.http_request(
|
|
"test_dynamic_handler_auth_without_password?query=select+currentUser()"
|
|
).content, "without_password"
|
|
|
|
|
|
def test_predefined_query_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "predefined_handler", "test_predefined_handler"
|
|
)
|
|
) as cluster:
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"?max_threads=1", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_predefined_handler_get?max_threads=1",
|
|
method="GET",
|
|
headers={"XXX": "bad"},
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_predefined_handler_get?max_threads=1",
|
|
method="POST",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
500
|
|
== cluster.instance.http_request(
|
|
"test_predefined_handler_get?max_threads=1",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
|
|
res1 = cluster.instance.http_request(
|
|
"test_predefined_handler_get?max_threads=1&setting_name=max_threads",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
)
|
|
assert b"max_threads\t1\n" == res1.content
|
|
assert (
|
|
"text/tab-separated-values; charset=UTF-8" == res1.headers["content-type"]
|
|
)
|
|
|
|
res2 = cluster.instance.http_request(
|
|
"query_param_with_url/max_threads?max_threads=1&max_final_threads=1",
|
|
headers={"XXX": "max_final_threads"},
|
|
)
|
|
assert b"max_final_threads\t1\nmax_threads\t1\n" == res2.content
|
|
assert "application/generic+one" == res2.headers["content-type"]
|
|
assert "it works" == res2.headers["X-Test-Http-Response-Headers-Works"]
|
|
assert (
|
|
"also works" == res2.headers["X-Test-Http-Response-Headers-Even-Multiple"]
|
|
)
|
|
|
|
cluster.instance.query(
|
|
"CREATE TABLE test_table (id UInt32, data String) Engine=TinyLog"
|
|
)
|
|
res3 = cluster.instance.http_request(
|
|
"test_predefined_handler_post_body?id=100",
|
|
method="POST",
|
|
data="TEST".encode("utf8"),
|
|
)
|
|
assert res3.status_code == 200
|
|
assert cluster.instance.query("SELECT * FROM test_table") == "100\tTEST\n"
|
|
cluster.instance.query("DROP TABLE test_table")
|
|
|
|
res4 = cluster.instance.http_request(
|
|
"test_predefined_handler_get?max_threads=1¶m_setting_name=max_threads",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
)
|
|
assert b"max_threads\t1\n" == res1.content
|
|
|
|
assert cluster.instance.http_request(
|
|
"test_predefined_handler_auth_with_password"
|
|
).content, "with_password"
|
|
assert cluster.instance.http_request(
|
|
"test_predefined_handler_auth_with_password_fail"
|
|
).status_code, 403
|
|
assert cluster.instance.http_request(
|
|
"test_predefined_handler_auth_without_password"
|
|
).content, "without_password"
|
|
|
|
|
|
def test_fixed_static_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "static_handler", "test_static_handler"
|
|
)
|
|
) as cluster:
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="GET", headers={"XXX": "bad"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="POST", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
402
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
assert (
|
|
"text/html; charset=UTF-8"
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).headers["Content-Type"]
|
|
)
|
|
assert (
|
|
b"Test get static handler and fix content"
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).content
|
|
)
|
|
assert (
|
|
"it works"
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).headers["X-Test-Http-Response-Headers-Works"]
|
|
)
|
|
assert (
|
|
"also works"
|
|
== cluster.instance.http_request(
|
|
"test_get_fixed_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).headers["X-Test-Http-Response-Headers-Even-Multiple"]
|
|
)
|
|
|
|
|
|
def test_config_static_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "static_handler", "test_static_handler"
|
|
)
|
|
) as cluster:
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_config_static_handler", method="GET", headers={"XXX": "bad"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_config_static_handler", method="POST", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
# check default status code
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"test_get_config_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
assert (
|
|
"text/plain; charset=UTF-8"
|
|
== cluster.instance.http_request(
|
|
"test_get_config_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).headers["Content-Type"]
|
|
)
|
|
assert (
|
|
b"Test get static handler and config content"
|
|
== cluster.instance.http_request(
|
|
"test_get_config_static_handler", method="GET", headers={"XXX": "xxx"}
|
|
).content
|
|
)
|
|
|
|
|
|
def test_absolute_path_static_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "static_handler", "test_static_handler"
|
|
)
|
|
) as cluster:
|
|
cluster.instance.exec_in_container(
|
|
[
|
|
"bash",
|
|
"-c",
|
|
'echo "<html><body>Absolute Path File</body></html>" > /var/lib/clickhouse/user_files/absolute_path_file.html',
|
|
],
|
|
privileged=True,
|
|
user="root",
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_absolute_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "bad"},
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_absolute_path_static_handler",
|
|
method="POST",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
|
|
# check default status code
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"test_get_absolute_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
assert (
|
|
"text/html; charset=UTF-8"
|
|
== cluster.instance.http_request(
|
|
"test_get_absolute_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).headers["Content-Type"]
|
|
)
|
|
assert (
|
|
b"<html><body>Absolute Path File</body></html>\n"
|
|
== cluster.instance.http_request(
|
|
"test_get_absolute_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).content
|
|
)
|
|
|
|
|
|
def test_relative_path_static_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "static_handler", "test_static_handler"
|
|
)
|
|
) as cluster:
|
|
cluster.instance.exec_in_container(
|
|
[
|
|
"bash",
|
|
"-c",
|
|
'echo "<html><body>Relative Path File</body></html>" > /var/lib/clickhouse/user_files/relative_path_file.html',
|
|
],
|
|
privileged=True,
|
|
user="root",
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_relative_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "bad"},
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_get_relative_path_static_handler",
|
|
method="POST",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
|
|
# check default status code
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"test_get_relative_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).status_code
|
|
)
|
|
assert (
|
|
"text/html; charset=UTF-8"
|
|
== cluster.instance.http_request(
|
|
"test_get_relative_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).headers["Content-Type"]
|
|
)
|
|
assert (
|
|
b"<html><body>Relative Path File</body></html>\n"
|
|
== cluster.instance.http_request(
|
|
"test_get_relative_path_static_handler",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
).content
|
|
)
|
|
|
|
|
|
def test_defaults_http_handlers():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "defaults_handlers", "test_defaults_handlers"
|
|
)
|
|
) as cluster:
|
|
assert 200 == cluster.instance.http_request("", method="GET").status_code
|
|
assert (
|
|
b"Default server response"
|
|
== cluster.instance.http_request("", method="GET").content
|
|
)
|
|
|
|
assert 200 == cluster.instance.http_request("ping", method="GET").status_code
|
|
assert b"Ok.\n" == cluster.instance.http_request("ping", method="GET").content
|
|
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"replicas_status", method="get"
|
|
).status_code
|
|
)
|
|
assert (
|
|
b"Ok.\n"
|
|
== cluster.instance.http_request("replicas_status", method="get").content
|
|
)
|
|
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"replicas_status?verbose=1", method="get"
|
|
).status_code
|
|
)
|
|
assert (
|
|
b""
|
|
== cluster.instance.http_request(
|
|
"replicas_status?verbose=1", method="get"
|
|
).content
|
|
)
|
|
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"?query=SELECT+1", method="GET"
|
|
).status_code
|
|
)
|
|
assert (
|
|
b"1\n"
|
|
== cluster.instance.http_request("?query=SELECT+1", method="GET").content
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"/nonexistent?query=SELECT+1", method="GET"
|
|
).status_code
|
|
)
|
|
|
|
|
|
def test_defaults_http_handlers_config_order():
|
|
def check_predefined_query_handler():
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"?query=SELECT+1", method="GET"
|
|
).status_code
|
|
)
|
|
assert (
|
|
b"1\n"
|
|
== cluster.instance.http_request("?query=SELECT+1", method="GET").content
|
|
)
|
|
response = cluster.instance.http_request(
|
|
"test_predefined_handler_get?max_threads=1&setting_name=max_threads",
|
|
method="GET",
|
|
headers={"XXX": "xxx"},
|
|
)
|
|
assert b"max_threads\t1\n" == response.content
|
|
assert (
|
|
"text/tab-separated-values; charset=UTF-8"
|
|
== response.headers["content-type"]
|
|
)
|
|
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__),
|
|
"defaults_handlers_config_order_first",
|
|
"test_defaults_handlers_config_order/defaults_first",
|
|
)
|
|
) as cluster:
|
|
check_predefined_query_handler()
|
|
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__),
|
|
"defaults_handlers_config_order_first",
|
|
"test_defaults_handlers_config_order/defaults_last",
|
|
)
|
|
) as cluster:
|
|
check_predefined_query_handler()
|
|
|
|
|
|
def test_prometheus_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__), "prometheus_handler", "test_prometheus_handler"
|
|
)
|
|
) as cluster:
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_prometheus", method="GET", headers={"XXX": "bad"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_prometheus", method="POST", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"test_prometheus", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
assert (
|
|
b"ClickHouseProfileEvents_Query"
|
|
in cluster.instance.http_request(
|
|
"test_prometheus", method="GET", headers={"XXX": "xxx"}
|
|
).content
|
|
)
|
|
|
|
|
|
def test_replicas_status_handler():
|
|
with contextlib.closing(
|
|
SimpleCluster(
|
|
ClickHouseCluster(__file__),
|
|
"replicas_status_handler",
|
|
"test_replicas_status_handler",
|
|
)
|
|
) as cluster:
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_replicas_status", method="GET", headers={"XXX": "bad"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
404
|
|
== cluster.instance.http_request(
|
|
"test_replicas_status", method="POST", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
|
|
assert (
|
|
200
|
|
== cluster.instance.http_request(
|
|
"test_replicas_status", method="GET", headers={"XXX": "xxx"}
|
|
).status_code
|
|
)
|
|
assert (
|
|
b"Ok.\n"
|
|
== cluster.instance.http_request(
|
|
"test_replicas_status", method="GET", headers={"XXX": "xxx"}
|
|
).content
|
|
)
|