1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import functools
import os
from collections.abc import Iterable
from typing import Any
import testinfra.backend
import testinfra.backend.base
import testinfra.modules
import testinfra.modules.base
class Host:
_host_cache: dict[tuple[str, frozenset[tuple[str, Any]]], "Host"] = {}
_hosts_cache: dict[
tuple[frozenset[str], frozenset[tuple[str, Any]]], list["Host"]
] = {}
def __init__(self, backend: testinfra.backend.base.BaseBackend):
self.backend = backend
super().__init__()
def __repr__(self) -> str:
return f"<testinfra.host.Host {self.backend.get_pytest_id()}>"
@functools.cached_property
def has_command_v(self) -> bool:
"""Return True if `command -v` is available"""
return self.run("command -v command").rc == 0
def exists(self, command: str) -> bool:
"""Return True if given command exist in $PATH"""
if self.has_command_v:
out = self.run("command -v %s", command)
else:
out = self.run_expect([0, 1], "which %s", command)
return out.rc == 0
def find_command(
self, command: str, extrapaths: Iterable[str] = ("/sbin", "/usr/sbin")
) -> str:
"""Return path of given command
raise ValueError if command cannot be found
"""
if self.has_command_v:
out = self.run("command -v %s", command)
else:
out = self.run_expect([0, 1], "which %s", command)
if out.rc == 0:
return out.stdout.rstrip("\r\n")
for basedir in extrapaths:
path = os.path.join(basedir, command)
if self.exists(path):
return path
raise ValueError(f'cannot find "{command}" command')
def run(
self, command: str, *args: str, **kwargs: Any
) -> testinfra.backend.base.CommandResult:
"""Run given command and return rc (exit status), stdout and stderr
>>> cmd = host.run("ls -l /etc/passwd")
>>> cmd.rc
0
>>> cmd.stdout
'-rw-r--r-- 1 root root 1790 Feb 11 00:28 /etc/passwd\\n'
>>> cmd.stderr
''
>>> cmd.succeeded
True
>>> cmd.failed
False
Good practice: always use shell arguments quoting to avoid shell
injection
>>> cmd = host.run("ls -l -- %s", "/;echo inject")
CommandResult(
rc=2, stdout='',
stderr=(
'ls: cannot access /;echo inject: No such file or directory\\n'),
command="ls -l '/;echo inject'")
"""
return self.backend.run(command, *args, **kwargs)
def run_expect(
self, expected: list[int], command: str, *args: str, **kwargs: Any
) -> testinfra.backend.base.CommandResult:
"""Run command and check it return an expected exit status
:param expected: A list of expected exit status
:raises: AssertionError
"""
__tracebackhide__ = True
out = self.run(command, *args, **kwargs)
assert out.rc in expected, f"Unexpected exit code {out.rc} for {out}"
return out
def run_test(
self, command: str, *args: str, **kwargs: Any
) -> testinfra.backend.base.CommandResult:
"""Run command and check it return an exit status of 0 or 1
:raises: AssertionError
"""
return self.run_expect([0, 1], command, *args, **kwargs)
def check_output(self, command: str, *args: str, **kwargs: Any) -> str:
"""Get stdout of a command which has run successfully
:returns: stdout without trailing newline
:raises: AssertionError
"""
__tracebackhide__ = True
out = self.run(command, *args, **kwargs)
assert out.rc == 0, f"Unexpected exit code {out.rc} for {out}"
return out.stdout.rstrip("\r\n")
def __getattr__(self, name: str) -> type[testinfra.modules.base.Module]:
if name in testinfra.modules.modules:
module_class = testinfra.modules.get_module_class(name)
obj = module_class.get_module(self)
setattr(self, name, obj)
return obj
raise AttributeError(
f"'{self.__class__.__name__}' object has no attribute '{name}'"
)
@classmethod
def get_host(cls, hostspec: str, **kwargs: Any) -> "Host":
"""Return a Host instance from `hostspec`
`hostspec` should be like
`<backend_type>://<name>?param1=value1¶m2=value2`
Params can also be passed in `**kwargs` (eg. get_host("local://",
sudo=True) is equivalent to get_host("local://?sudo=true"))
Examples::
>>> get_host("local://", sudo=True)
>>> get_host("paramiko://user@host", ssh_config="/path/my_ssh_config")
>>> get_host("ansible://all?ansible_inventory=/etc/ansible/inventory")
"""
key = (hostspec, frozenset(kwargs.items()))
cache = cls._host_cache
if key not in cache:
backend = testinfra.backend.get_backend(hostspec, **kwargs)
cache[key] = host = cls(backend)
backend.set_host(host)
return cache[key]
@classmethod
def get_hosts(cls, hosts: Iterable[str], **kwargs: Any) -> list["Host"]:
key = (frozenset(hosts), frozenset(kwargs.items()))
cache = cls._hosts_cache
if key not in cache:
cache[key] = []
for backend in testinfra.backend.get_backends(hosts, **kwargs):
host = cls(backend)
backend.set_host(host)
cache[key].append(host)
return cache[key]
get_host = Host.get_host
get_hosts = Host.get_hosts
|
