563 lines
28 KiB
HTML
563 lines
28 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
|
||
<meta name="generator" content="pdoc3 0.11.6">
|
||
<title>connpy.services.execution_service API documentation</title>
|
||
<meta name="description" content="">
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
|
||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
|
||
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
||
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
|
||
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
||
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
|
||
<script>window.addEventListener('DOMContentLoaded', () => {
|
||
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
|
||
hljs.highlightAll();
|
||
/* Collapse source docstrings */
|
||
setTimeout(() => {
|
||
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
|
||
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
|
||
.forEach(el => {
|
||
let d = document.createElement('details');
|
||
d.classList.add('hljs-string');
|
||
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
|
||
el.replaceWith(d);
|
||
});
|
||
}, 100);
|
||
})</script>
|
||
</head>
|
||
<body>
|
||
<main>
|
||
<article id="content">
|
||
<header>
|
||
<h1 class="title">Module <code>connpy.services.execution_service</code></h1>
|
||
</header>
|
||
<section id="section-intro">
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
<h2 class="section-title" id="header-classes">Classes</h2>
|
||
<dl>
|
||
<dt id="connpy.services.execution_service.ExecutionService"><code class="flex name class">
|
||
<span>class <span class="ident">ExecutionService</span></span>
|
||
<span>(</span><span>config=None, remote_stub=None, attempt_tracker=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class ExecutionService(BaseService):
|
||
"""Business logic for executing commands on nodes and running automation scripts."""
|
||
|
||
def __init__(self, config=None, remote_stub=None, attempt_tracker=None):
|
||
super().__init__(config)
|
||
self.remote_stub = remote_stub
|
||
self.attempt_tracker = (
|
||
attempt_tracker if attempt_tracker is not None else AuthAttemptTracker()
|
||
)
|
||
self.last_fallback_used: dict[str, bool] = {}
|
||
|
||
def _is_remote_backend(self) -> bool:
|
||
"""Return True when execution is configured to run against a remote gRPC backend."""
|
||
if getattr(self, "remote_stub", None) is not None:
|
||
return True
|
||
cfg = getattr(self.config, "config", None)
|
||
return isinstance(cfg, dict) and cfg.get("service_mode") == "remote"
|
||
|
||
def _ensure_backend_supports_stage_timeouts(
|
||
self,
|
||
connect_timeout: int | None = None,
|
||
auth_timeout: int | None = None,
|
||
) -> None:
|
||
"""Raise ConnpyError if per-stage timeout overrides are used on gRPC remote backend."""
|
||
if self._is_remote_backend() and (connect_timeout is not None or auth_timeout is not None):
|
||
raise ConnpyError(
|
||
"connect_timeout and auth_timeout overrides are not supported in remote gRPC mode"
|
||
)
|
||
|
||
def _get_remote_stub(self):
|
||
"""Return the configured or lazily constructed ExecutionStub for remote gRPC mode."""
|
||
if getattr(self, "remote_stub", None) is not None:
|
||
return self.remote_stub
|
||
cfg = getattr(self.config, "config", None)
|
||
remote_host = cfg.get("remote_host") if isinstance(cfg, dict) else None
|
||
if not remote_host:
|
||
raise ConnpyError("Remote host must be specified in remote mode")
|
||
|
||
import grpc
|
||
|
||
from connpy.grpc_layer.stubs import AuthClientInterceptor, ExecutionStub
|
||
|
||
def get_token():
|
||
env_token = os.environ.get("CONNPY_TOKEN")
|
||
if env_token:
|
||
return env_token
|
||
defaultdir = getattr(self.config, "defaultdir", None)
|
||
if defaultdir:
|
||
token_path = os.path.join(defaultdir, ".token")
|
||
if os.path.exists(token_path):
|
||
with suppress(OSError), open(token_path) as f:
|
||
return f.read().strip()
|
||
return None
|
||
|
||
channel = grpc.insecure_channel(remote_host)
|
||
channel = grpc.intercept_channel(channel, AuthClientInterceptor(get_token))
|
||
return ExecutionStub(channel, remote_host=remote_host)
|
||
|
||
def run_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: list[str],
|
||
variables: dict[str, Any] | None = None,
|
||
parallel: int = 10,
|
||
timeout: int | None = None,
|
||
folder: str | None = None,
|
||
prompt: str | None = None,
|
||
on_node_complete: Callable | None = None,
|
||
logger: Callable | None = None,
|
||
name: str | None = None,
|
||
connect_timeout: int | None = None,
|
||
auth_timeout: int | None = None,
|
||
) -> dict[str, Any]:
|
||
"""Execute commands on a set of nodes."""
|
||
try:
|
||
self._ensure_backend_supports_stage_timeouts(
|
||
connect_timeout=connect_timeout,
|
||
auth_timeout=auth_timeout,
|
||
)
|
||
|
||
if self._is_remote_backend():
|
||
stub = self._get_remote_stub()
|
||
return stub.run_commands(
|
||
nodes_filter=nodes_filter,
|
||
commands=commands,
|
||
variables=variables,
|
||
parallel=parallel,
|
||
timeout=timeout if timeout is not None else 20,
|
||
folder=folder,
|
||
prompt=prompt,
|
||
on_node_complete=on_node_complete,
|
||
logger=logger,
|
||
name=name or "",
|
||
)
|
||
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
run_kwargs: dict[str, Any] = {
|
||
"commands": commands,
|
||
"vars": variables,
|
||
"parallel": parallel,
|
||
"timeout": timeout,
|
||
"folder": folder,
|
||
"prompt": prompt,
|
||
"on_complete": on_node_complete,
|
||
"logger": logger,
|
||
"connect_timeout": connect_timeout,
|
||
"auth_timeout": auth_timeout,
|
||
"_default_cmd_timeout": 20,
|
||
}
|
||
run_params = inspect.signature(executor.run).parameters
|
||
if "unattended" in run_params:
|
||
run_kwargs["unattended"] = True
|
||
if "attempt_tracker" in run_params:
|
||
run_kwargs["attempt_tracker"] = self.attempt_tracker
|
||
|
||
results = executor.run(**run_kwargs)
|
||
|
||
fb_map = getattr(executor, "fallback_used", {})
|
||
fb_dict = fb_map if isinstance(fb_map, dict) else {}
|
||
|
||
# Combine output, status, and fallback metadata for the caller
|
||
full_results = {}
|
||
self.last_fallback_used = {}
|
||
for unique in results:
|
||
fb_used = bool(fb_dict.get(unique, False))
|
||
full_results[unique] = {
|
||
"output": results[unique],
|
||
"status": executor.status.get(unique, 1),
|
||
"fallback_used": fb_used,
|
||
}
|
||
self.last_fallback_used[unique] = fb_used
|
||
|
||
return full_results
|
||
except ConnpyError:
|
||
raise
|
||
except Exception as e: # noqa: BLE001
|
||
raise_sanitized_auth_error(e, code="AUTH_FAILED", context_label="execution failed")
|
||
|
||
def test_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: list[str],
|
||
expected: list[str],
|
||
variables: dict[str, Any] | None = None,
|
||
parallel: int = 10,
|
||
timeout: int | None = None,
|
||
folder: str | None = None,
|
||
prompt: str | None = None,
|
||
on_node_complete: Callable | None = None,
|
||
logger: Callable | None = None,
|
||
name: str | None = None,
|
||
connect_timeout: int | None = None,
|
||
auth_timeout: int | None = None,
|
||
) -> dict[str, dict[str, bool]]:
|
||
"""Run commands and verify expected output on a set of nodes."""
|
||
try:
|
||
self._ensure_backend_supports_stage_timeouts(
|
||
connect_timeout=connect_timeout,
|
||
auth_timeout=auth_timeout,
|
||
)
|
||
|
||
if self._is_remote_backend():
|
||
stub = self._get_remote_stub()
|
||
return stub.test_commands(
|
||
nodes_filter=nodes_filter,
|
||
commands=commands,
|
||
expected=expected,
|
||
variables=variables,
|
||
parallel=parallel,
|
||
timeout=timeout if timeout is not None else 20,
|
||
folder=folder or "",
|
||
prompt=prompt,
|
||
on_node_complete=on_node_complete,
|
||
logger=logger,
|
||
name=name or "",
|
||
)
|
||
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
test_kwargs: dict[str, Any] = {
|
||
"commands": commands,
|
||
"expected": expected,
|
||
"vars": variables,
|
||
"parallel": parallel,
|
||
"timeout": timeout,
|
||
"folder": folder,
|
||
"prompt": prompt,
|
||
"on_complete": on_node_complete,
|
||
"logger": logger,
|
||
"connect_timeout": connect_timeout,
|
||
"auth_timeout": auth_timeout,
|
||
"_default_cmd_timeout": 20,
|
||
}
|
||
test_params = inspect.signature(executor.test).parameters
|
||
if "unattended" in test_params:
|
||
test_kwargs["unattended"] = True
|
||
if "attempt_tracker" in test_params:
|
||
test_kwargs["attempt_tracker"] = self.attempt_tracker
|
||
|
||
res = executor.test(**test_kwargs)
|
||
fb_map = getattr(executor, "fallback_used", {})
|
||
fb_dict = fb_map if isinstance(fb_map, dict) else {}
|
||
if isinstance(res, dict):
|
||
self.last_fallback_used = {u: bool(fb_dict.get(u, False)) for u in res}
|
||
else:
|
||
self.last_fallback_used = {}
|
||
return res
|
||
except ConnpyError:
|
||
raise
|
||
except Exception as e: # noqa: BLE001
|
||
raise_sanitized_auth_error(e, code="AUTH_FAILED", context_label="testing failed")
|
||
|
||
def run_cli_script(self, nodes_filter: str, script_path: str, parallel: int = 10) -> dict[str, str]:
|
||
"""Run a plain-text script containing one command per line."""
|
||
if not os.path.exists(script_path):
|
||
raise ConnpyError(f"Script file not found: {script_path}")
|
||
|
||
try:
|
||
with open(script_path) as f:
|
||
commands = [line.strip() for line in f if line.strip()]
|
||
except OSError:
|
||
raise ConnpyError("Failed to read script file") from None
|
||
|
||
return self.run_commands(nodes_filter, commands, parallel=parallel)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for executing commands on nodes and running automation scripts.</p>
|
||
<p>Initialize the service.</p>
|
||
<dl>
|
||
<dt>Args</dt>
|
||
<dt>-----=</dt>
|
||
<dt><strong><code>config</code></strong></dt>
|
||
<dd>An instance of configfile (or None to instantiate a new one/use global context).</dd>
|
||
</dl></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.base.BaseService" href="base.html#connpy.services.base.BaseService">BaseService</a></li>
|
||
</ul>
|
||
<h3>Methods</h3>
|
||
<dl>
|
||
<dt id="connpy.services.execution_service.ExecutionService.run_cli_script"><code class="name flex">
|
||
<span>def <span class="ident">run_cli_script</span></span>(<span>self, nodes_filter: str, script_path: str, parallel: int = 10) ‑> dict[str, str]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def run_cli_script(self, nodes_filter: str, script_path: str, parallel: int = 10) -> dict[str, str]:
|
||
"""Run a plain-text script containing one command per line."""
|
||
if not os.path.exists(script_path):
|
||
raise ConnpyError(f"Script file not found: {script_path}")
|
||
|
||
try:
|
||
with open(script_path) as f:
|
||
commands = [line.strip() for line in f if line.strip()]
|
||
except OSError:
|
||
raise ConnpyError("Failed to read script file") from None
|
||
|
||
return self.run_commands(nodes_filter, commands, parallel=parallel)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Run a plain-text script containing one command per line.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.execution_service.ExecutionService.run_commands"><code class="name flex">
|
||
<span>def <span class="ident">run_commands</span></span>(<span>self,<br>nodes_filter: str,<br>commands: list[str],<br>variables: dict[str, typing.Any] | None = None,<br>parallel: int = 10,<br>timeout: int | None = None,<br>folder: str | None = None,<br>prompt: str | None = None,<br>on_node_complete: collections.abc.Callable | None = None,<br>logger: collections.abc.Callable | None = None,<br>name: str | None = None,<br>connect_timeout: int | None = None,<br>auth_timeout: int | None = None) ‑> dict[str, typing.Any]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def run_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: list[str],
|
||
variables: dict[str, Any] | None = None,
|
||
parallel: int = 10,
|
||
timeout: int | None = None,
|
||
folder: str | None = None,
|
||
prompt: str | None = None,
|
||
on_node_complete: Callable | None = None,
|
||
logger: Callable | None = None,
|
||
name: str | None = None,
|
||
connect_timeout: int | None = None,
|
||
auth_timeout: int | None = None,
|
||
) -> dict[str, Any]:
|
||
"""Execute commands on a set of nodes."""
|
||
try:
|
||
self._ensure_backend_supports_stage_timeouts(
|
||
connect_timeout=connect_timeout,
|
||
auth_timeout=auth_timeout,
|
||
)
|
||
|
||
if self._is_remote_backend():
|
||
stub = self._get_remote_stub()
|
||
return stub.run_commands(
|
||
nodes_filter=nodes_filter,
|
||
commands=commands,
|
||
variables=variables,
|
||
parallel=parallel,
|
||
timeout=timeout if timeout is not None else 20,
|
||
folder=folder,
|
||
prompt=prompt,
|
||
on_node_complete=on_node_complete,
|
||
logger=logger,
|
||
name=name or "",
|
||
)
|
||
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
run_kwargs: dict[str, Any] = {
|
||
"commands": commands,
|
||
"vars": variables,
|
||
"parallel": parallel,
|
||
"timeout": timeout,
|
||
"folder": folder,
|
||
"prompt": prompt,
|
||
"on_complete": on_node_complete,
|
||
"logger": logger,
|
||
"connect_timeout": connect_timeout,
|
||
"auth_timeout": auth_timeout,
|
||
"_default_cmd_timeout": 20,
|
||
}
|
||
run_params = inspect.signature(executor.run).parameters
|
||
if "unattended" in run_params:
|
||
run_kwargs["unattended"] = True
|
||
if "attempt_tracker" in run_params:
|
||
run_kwargs["attempt_tracker"] = self.attempt_tracker
|
||
|
||
results = executor.run(**run_kwargs)
|
||
|
||
fb_map = getattr(executor, "fallback_used", {})
|
||
fb_dict = fb_map if isinstance(fb_map, dict) else {}
|
||
|
||
# Combine output, status, and fallback metadata for the caller
|
||
full_results = {}
|
||
self.last_fallback_used = {}
|
||
for unique in results:
|
||
fb_used = bool(fb_dict.get(unique, False))
|
||
full_results[unique] = {
|
||
"output": results[unique],
|
||
"status": executor.status.get(unique, 1),
|
||
"fallback_used": fb_used,
|
||
}
|
||
self.last_fallback_used[unique] = fb_used
|
||
|
||
return full_results
|
||
except ConnpyError:
|
||
raise
|
||
except Exception as e: # noqa: BLE001
|
||
raise_sanitized_auth_error(e, code="AUTH_FAILED", context_label="execution failed")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Execute commands on a set of nodes.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.execution_service.ExecutionService.test_commands"><code class="name flex">
|
||
<span>def <span class="ident">test_commands</span></span>(<span>self,<br>nodes_filter: str,<br>commands: list[str],<br>expected: list[str],<br>variables: dict[str, typing.Any] | None = None,<br>parallel: int = 10,<br>timeout: int | None = None,<br>folder: str | None = None,<br>prompt: str | None = None,<br>on_node_complete: collections.abc.Callable | None = None,<br>logger: collections.abc.Callable | None = None,<br>name: str | None = None,<br>connect_timeout: int | None = None,<br>auth_timeout: int | None = None) ‑> dict[str, dict[str, bool]]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def test_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: list[str],
|
||
expected: list[str],
|
||
variables: dict[str, Any] | None = None,
|
||
parallel: int = 10,
|
||
timeout: int | None = None,
|
||
folder: str | None = None,
|
||
prompt: str | None = None,
|
||
on_node_complete: Callable | None = None,
|
||
logger: Callable | None = None,
|
||
name: str | None = None,
|
||
connect_timeout: int | None = None,
|
||
auth_timeout: int | None = None,
|
||
) -> dict[str, dict[str, bool]]:
|
||
"""Run commands and verify expected output on a set of nodes."""
|
||
try:
|
||
self._ensure_backend_supports_stage_timeouts(
|
||
connect_timeout=connect_timeout,
|
||
auth_timeout=auth_timeout,
|
||
)
|
||
|
||
if self._is_remote_backend():
|
||
stub = self._get_remote_stub()
|
||
return stub.test_commands(
|
||
nodes_filter=nodes_filter,
|
||
commands=commands,
|
||
expected=expected,
|
||
variables=variables,
|
||
parallel=parallel,
|
||
timeout=timeout if timeout is not None else 20,
|
||
folder=folder or "",
|
||
prompt=prompt,
|
||
on_node_complete=on_node_complete,
|
||
logger=logger,
|
||
name=name or "",
|
||
)
|
||
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
test_kwargs: dict[str, Any] = {
|
||
"commands": commands,
|
||
"expected": expected,
|
||
"vars": variables,
|
||
"parallel": parallel,
|
||
"timeout": timeout,
|
||
"folder": folder,
|
||
"prompt": prompt,
|
||
"on_complete": on_node_complete,
|
||
"logger": logger,
|
||
"connect_timeout": connect_timeout,
|
||
"auth_timeout": auth_timeout,
|
||
"_default_cmd_timeout": 20,
|
||
}
|
||
test_params = inspect.signature(executor.test).parameters
|
||
if "unattended" in test_params:
|
||
test_kwargs["unattended"] = True
|
||
if "attempt_tracker" in test_params:
|
||
test_kwargs["attempt_tracker"] = self.attempt_tracker
|
||
|
||
res = executor.test(**test_kwargs)
|
||
fb_map = getattr(executor, "fallback_used", {})
|
||
fb_dict = fb_map if isinstance(fb_map, dict) else {}
|
||
if isinstance(res, dict):
|
||
self.last_fallback_used = {u: bool(fb_dict.get(u, False)) for u in res}
|
||
else:
|
||
self.last_fallback_used = {}
|
||
return res
|
||
except ConnpyError:
|
||
raise
|
||
except Exception as e: # noqa: BLE001
|
||
raise_sanitized_auth_error(e, code="AUTH_FAILED", context_label="testing failed")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Run commands and verify expected output on a set of nodes.</p></div>
|
||
</dd>
|
||
</dl>
|
||
<h3>Inherited members</h3>
|
||
<ul class="hlist">
|
||
<li><code><b><a title="connpy.services.base.BaseService" href="base.html#connpy.services.base.BaseService">BaseService</a></b></code>:
|
||
<ul class="hlist">
|
||
<li><code><a title="connpy.services.base.BaseService.set_reserved_names" href="base.html#connpy.services.base.BaseService.set_reserved_names">set_reserved_names</a></code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
</article>
|
||
<nav id="sidebar">
|
||
<div class="toc">
|
||
<ul></ul>
|
||
</div>
|
||
<ul id="index">
|
||
<li><h3>Super-module</h3>
|
||
<ul>
|
||
<li><code><a title="connpy.services" href="index.html">connpy.services</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li><h3><a href="#header-classes">Classes</a></h3>
|
||
<ul>
|
||
<li>
|
||
<h4><code><a title="connpy.services.execution_service.ExecutionService" href="#connpy.services.execution_service.ExecutionService">ExecutionService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.execution_service.ExecutionService.run_cli_script" href="#connpy.services.execution_service.ExecutionService.run_cli_script">run_cli_script</a></code></li>
|
||
<li><code><a title="connpy.services.execution_service.ExecutionService.run_commands" href="#connpy.services.execution_service.ExecutionService.run_commands">run_commands</a></code></li>
|
||
<li><code><a title="connpy.services.execution_service.ExecutionService.test_commands" href="#connpy.services.execution_service.ExecutionService.test_commands">test_commands</a></code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
</main>
|
||
<footer id="footer">
|
||
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
|
||
</footer>
|
||
</body>
|
||
</html>
|