GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

cloudflare/cloudflared

Public

mirrored from https://github.com/cloudflare/cloudflaredAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
2026.5.1

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

cloudflared/component-tests

component-tests/cli.py

117lines · modeblame

RawDownload
Latest commit unavailable.
e921ab35Devin Carr4 years ago1import json
2import subprocess
3
ee5e447dDevin Carr3 years ago4from constants import MANAGEMENT_HOST_NAME
e921ab35Devin Carr4 years ago5from setup import get_config_from_file
905d983dMiguel da Costa Martins Marcelino1 months ago6from util import get_tunnel_connector_id, CloudflaredProcess
e921ab35Devin Carr4 years ago7
8SINGLE_CASE_TIMEOUT = 600
9
10class CloudflaredCli:
11def __init__(self, config, config_path, logger):
12self.basecmd = [config.cloudflared_binary, "tunnel"]
13if config_path is not None:
14self.basecmd += ["--config", str(config_path)]
15origincert = get_config_from_file()["origincert"]
16if origincert:
17self.basecmd += ["--origincert", origincert]
18self.logger = logger
19
20def _run_command(self, subcmd, subcmd_name, needs_to_pass=True):
21cmd = self.basecmd + subcmd
22# timeout limits the time a subprocess can run. This is useful to guard against running a tunnel when
23# command/args are in wrong order.
24result = run_subprocess(cmd, subcmd_name, self.logger, check=needs_to_pass, capture_output=True, timeout=15)
25return result
26
27def list_tunnels(self):
28cmd_args = ["list", "--output", "json"]
29listed = self._run_command(cmd_args, "list")
30return json.loads(listed.stdout)
31
372a4b70Gonçalo Garcia3 months ago32def get_management_token(self, config, config_path, resource):
5e212a6bSudarsan Reddy3 years ago33basecmd = [config.cloudflared_binary]
34if config_path is not None:
35basecmd += ["--config", str(config_path)]
36origincert = get_config_from_file()["origincert"]
37if origincert:
38basecmd += ["--origincert", origincert]
39
372a4b70Gonçalo Garcia3 months ago40cmd_args = ["management", "token", "--resource", resource, config.get_tunnel_id()]
5e212a6bSudarsan Reddy3 years ago41cmd = basecmd + cmd_args
42result = run_subprocess(cmd, "token", self.logger, check=True, capture_output=True, timeout=15)
43return json.loads(result.stdout.decode("utf-8").strip())["token"]
ee5e447dDevin Carr3 years ago44
372a4b70Gonçalo Garcia3 months ago45def get_tail_token(self, config, config_path):
46"""
47Get management token using the 'tail token' command.
48Returns a token scoped for 'logs' resource.
49"""
50basecmd = [config.cloudflared_binary]
51if config_path is not None:
52basecmd += ["--config", str(config_path)]
53origincert = get_config_from_file()["origincert"]
54if origincert:
55basecmd += ["--origincert", origincert]
56
57cmd_args = ["tail", "token", config.get_tunnel_id()]
58cmd = basecmd + cmd_args
59result = run_subprocess(cmd, "tail-token", self.logger, check=True, capture_output=True, timeout=15)
60return json.loads(result.stdout.decode("utf-8").strip())["token"]
61
62def get_management_url(self, path, config, config_path, resource):
63access_jwt = self.get_management_token(config, config_path, resource)
ee5e447dDevin Carr3 years ago64connector_id = get_tunnel_connector_id()
65return f"https://{MANAGEMENT_HOST_NAME}/{path}?connector_id={connector_id}&access_token={access_jwt}"
66
372a4b70Gonçalo Garcia3 months ago67def get_management_wsurl(self, path, config, config_path, resource):
68access_jwt = self.get_management_token(config, config_path, resource)
ee5e447dDevin Carr3 years ago69connector_id = get_tunnel_connector_id()
70return f"wss://{MANAGEMENT_HOST_NAME}/{path}?connector_id={connector_id}&access_token={access_jwt}"
5e212a6bSudarsan Reddy3 years ago71
72def get_connector_id(self, config):
73op = self.get_tunnel_info(config.get_tunnel_id())
74connectors = []
75for conn in op["conns"]:
76connectors.append(conn["id"])
77return connectors
78
e921ab35Devin Carr4 years ago79def get_tunnel_info(self, tunnel_id):
80info = self._run_command(["info", "--output", "json", tunnel_id], "info")
81return json.loads(info.stdout)
82
83def __enter__(self):
84self.basecmd += ["run"]
85self.logger.info(f"Run cmd {self.basecmd}")
905d983dMiguel da Costa Martins Marcelino1 months ago86self.cfd = CloudflaredProcess(self.basecmd, allow_input=False, capture_output=True)
87return self.cfd
e921ab35Devin Carr4 years ago88
89def __exit__(self, exc_type, exc_value, exc_traceback):
905d983dMiguel da Costa Martins Marcelino1 months ago90self.cfd.cleanup()
e921ab35Devin Carr4 years ago91
92
93def cert_path():
94return get_config_from_file()["origincert"]
95
96
97class SubprocessError(Exception):
98def __init__(self, program, exit_code, cause):
99self.program = program
100self.exit_code = exit_code
101self.cause = cause
102
103
104def run_subprocess(cmd, cmd_name, logger, timeout=SINGLE_CASE_TIMEOUT, **kargs):
105kargs["timeout"] = timeout
106try:
107result = subprocess.run(cmd, **kargs)
108logger.debug(f"{cmd} log: {result.stdout}", extra={"cmd": cmd_name})
109return result
110except subprocess.CalledProcessError as e:
111err = f"{cmd} return exit code {e.returncode}, stderr" + e.stderr.decode("utf-8")
112logger.error(err, extra={"cmd": cmd_name, "return_code": e.returncode})
113raise SubprocessError(cmd[0], e.returncode, e)
114except subprocess.TimeoutExpired as e:
115err = f"{cmd} timeout after {e.timeout} seconds, stdout: {e.stdout}, stderr: {e.stderr}"
116logger.error(err, extra={"cmd": cmd_name, "return_code": "timeout"})
117raise e