counterweight/query-performance-gauge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Functions to start and stop the SSH tunnel as part of the measuring session.

Browse source
This commit is contained in:
Pablo Martin 2022-07-21 18:30:40 +02:00
parent 7af07b3e11
commit 6a99fff921
1 changed files with 44 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

44
connections.py
View file

@ -124,3 +124,47 @@ def get_connection_to_mysql(
)
return connection
def clean_up_connection(connection_config: dict) -> None:
"""
Perform any necessary connection clean up steps after the measuring session.
:param connection_config: the connection details.
:return: none.
"""
if connection_config["ssh_tunneling"]["use_tunnel"]:
close_ssh_tunnel()
def open_ssh_tunnel(connection_config: dict) -> None:
"""
Start an SSH tunnel with the passed details.
:param connection_config: the connection details.
:return: none.
"""
print(
f"""Opening up an SSH tunnel to {connection_config["ssh_tunneling"]["ssh_host"]}"""
)
MySSHTunnel(
ssh_host=connection_config["ssh_tunneling"]["ssh_host"],
ssh_port=connection_config["ssh_tunneling"]["ssh_port"],
ssh_username=connection_config["ssh_tunneling"]["ssh_username"],
ssh_pkey=connection_config["ssh_tunneling"]["path_to_key"],
remote_host=connection_config["host"],
remote_port=connection_config["port"],
).start()
print("SSH tunnel is now open.")
def close_ssh_tunnel():
"""
Close the SSH tunnel. No details required because a singleton is being used.
:return: None
"""
print(f"Closing down the SSH tunnel...")
MySSHTunnel().stop()
print("SSH tunnel is now closed.")