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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
# 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 json
import re
from testinfra.modules.base import Module
class Interface(Module):
"""Test network interfaces
>>> host.interface("eth0").exists
True
Optionally, the protocol family to use can be enforced.
>>> host.interface("eth0", "inet6").addresses
['fe80::e291:f5ff:fe98:6b8c']
"""
def __init__(self, name, family=None):
self.name = name
self.family = family
super().__init__()
@property
def exists(self):
raise NotImplementedError
@property
def speed(self):
raise NotImplementedError
@property
def addresses(self):
"""Return ipv4 and ipv6 addresses on the interface
>>> host.interface("eth0").addresses
['192.168.31.254', '192.168.31.252', 'fe80::e291:f5ff:fe98:6b8c']
"""
raise NotImplementedError
@property
def link(self):
"""Return the link properties associated with the interface.
>>> host.interface("lo").link
{'address': '00:00:00:00:00:00',
'broadcast': '00:00:00:00:00:00',
'flags': ['LOOPBACK', 'UP', 'LOWER_UP'],
'group': 'default',
'ifindex': 1,
'ifname': 'lo',
'link_type': 'loopback',
'linkmode': 'DEFAULT',
'mtu': 65536,
'operstate': 'UNKNOWN',
'qdisc': 'noqueue',
'txqlen': 1000}
"""
raise NotImplementedError
def routes(self, scope=None):
"""Return the routes associated with the interface, optionally filtered by scope
("host", "link" or "global").
>>> host.interface("eth0").routes()
[{'dst': 'default',
'flags': [],
'gateway': '192.0.2.1',
'metric': 3003,
'prefsrc': '192.0.2.5',
'protocol': 'dhcp'},
{'dst': '192.0.2.0/24',
'flags': [],
'metric': 3003,
'prefsrc': '192.0.2.5',
'protocol': 'dhcp',
'scope': 'link'}]
"""
raise NotImplementedError
def __repr__(self):
return f"<interface {self.name}>"
@classmethod
def get_module_class(cls, host):
if host.system_info.type == "linux":
return LinuxInterface
if host.system_info.type.endswith("bsd"):
return BSDInterface
raise NotImplementedError
@classmethod
def names(cls):
"""Return the names of all the interfaces.
>>> host.interface.names()
['lo', 'tunl0', 'ip6tnl0', 'eth0']
"""
raise NotImplementedError
@classmethod
def default(cls, family=None):
"""Return the interface used for the default route.
>>> host.interface.default()
<interface eth0>
Optionally, the protocol family to use can be enforced.
>>> host.interface.default("inet6")
None
"""
raise NotImplementedError
class LinuxInterface(Interface):
@functools.cached_property
def _ip(self):
ip_cmd = self.find_command("ip")
if self.family is not None:
ip_cmd = f"{ip_cmd} -f {self.family}"
return ip_cmd
@property
def exists(self):
return self.run_test(f"{self._ip} link show %s", self.name).rc == 0
@property
def speed(self):
return int(self.check_output("cat /sys/class/net/%s/speed", self.name))
@property
def addresses(self):
stdout = self.check_output(f"{self._ip} addr show %s", self.name)
addrs = []
for line in stdout.splitlines():
splitted = [e.strip() for e in line.split(" ") if e]
if splitted and splitted[0] in ("inet", "inet6"):
addrs.append(splitted[1].split("/", 1)[0])
return addrs
@property
def link(self):
return json.loads(
self.check_output(f"{self._ip} --json link show %s", self.name)
)
def routes(self, scope=None):
cmd = f"{self._ip} --json route list dev %s"
if scope is None:
out = self.check_output(cmd, self.name)
else:
out = self.check_output(cmd + " scope %s", self.name, scope)
return json.loads(out)
@classmethod
def default(cls, family=None):
_default = cls(None, family=family)
out = cls.check_output(f"{_default._ip} route ls")
for line in out.splitlines():
if "default" in line:
match = re.search(r"dev\s(\S+)", line)
if match:
_default.name = match.group(1)
return _default
@classmethod
def names(cls):
# -o is to tell the ip command to return 1 line per interface
out = cls.check_output(f"{cls(None)._ip} -o link show")
interfaces = []
for line in out.splitlines():
interfaces.append(line.strip().split(": ", 2)[1].split("@", 1)[0])
return interfaces
class BSDInterface(Interface):
@property
def exists(self):
return self.run_test("ifconfig %s", self.name).rc == 0
@property
def speed(self):
raise NotImplementedError
@property
def addresses(self):
stdout = self.check_output("ifconfig %s", self.name)
addrs = []
for line in stdout.splitlines():
if line.startswith("\tinet "):
addrs.append(line.split(" ", 2)[1])
elif line.startswith("\tinet6 "):
addr = line.split(" ", 2)[1]
if "%" in addr:
addr = addr.split("%", 1)[0]
addrs.append(addr)
return addrs
|
