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
|
#!/usr/bin/env python3
#
# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import unittest
from base_vyostest_shim import VyOSUnitTestSHIM
from vyos.utils.process import process_named_running
from vyos.utils.file import read_file
NODE_EXPORTER_PROCESS_NAME = 'node_exporter'
FRR_EXPORTER_PROCESS_NAME = 'frr_exporter'
BLACKBOX_EXPORTER_PROCESS_NAME = 'blackbox_exporter'
base_path = ['service', 'monitoring', 'prometheus']
listen_if = 'dum3421'
listen_ip = '192.0.2.1'
node_exporter_service_file = '/etc/systemd/system/node_exporter.service'
frr_exporter_service_file = '/etc/systemd/system/frr_exporter.service'
blackbox_exporter_service_file = '/etc/systemd/system/blackbox_exporter.service'
class TestMonitoringPrometheus(VyOSUnitTestSHIM.TestCase):
@classmethod
def setUpClass(cls):
# call base-classes classmethod
super(TestMonitoringPrometheus, cls).setUpClass()
# create a test interfaces
cls.cli_set(
cls, ['interfaces', 'dummy', listen_if, 'address', listen_ip + '/32']
)
@classmethod
def tearDownClass(cls):
cls.cli_delete(cls, ['interfaces', 'dummy', listen_if])
super(TestMonitoringPrometheus, cls).tearDownClass()
def tearDown(self):
self.cli_delete(base_path)
self.cli_commit()
self.assertFalse(process_named_running(NODE_EXPORTER_PROCESS_NAME))
self.assertFalse(process_named_running(FRR_EXPORTER_PROCESS_NAME))
# always forward to base class
super().tearDown()
def test_01_node_exporter(self):
self.cli_set(base_path + ['node-exporter', 'listen-address', listen_ip])
self.cli_set(base_path + ['node-exporter', 'collectors', 'textfile'])
# commit changes
self.cli_commit()
file_content = read_file(node_exporter_service_file)
self.assertIn(f'{listen_ip}:9100', file_content)
self.assertTrue(os.path.isdir('/run/node_exporter/collector'))
self.assertIn(
'--collector.textfile.directory=/run/node_exporter/collector', file_content
)
# Check for running process
self.assertTrue(process_named_running(NODE_EXPORTER_PROCESS_NAME))
def test_02_frr_exporter(self):
self.cli_set(base_path + ['frr-exporter', 'listen-address', listen_ip])
# commit changes
self.cli_commit()
file_content = read_file(frr_exporter_service_file)
self.assertIn(f'{listen_ip}:9342', file_content)
# Check for running process
self.assertTrue(process_named_running(FRR_EXPORTER_PROCESS_NAME))
def test_03_blackbox_exporter(self):
self.cli_set(base_path + ['blackbox-exporter', 'listen-address', listen_ip])
# commit changes
self.cli_commit()
file_content = read_file(blackbox_exporter_service_file)
self.assertIn(f'{listen_ip}:9115', file_content)
# Check for running process
self.assertTrue(process_named_running(BLACKBOX_EXPORTER_PROCESS_NAME))
def test_04_blackbox_exporter_with_config(self):
self.cli_set(base_path + ['blackbox-exporter', 'listen-address', listen_ip])
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'dns',
'name',
'dns_ip4',
'preferred-ip-protocol',
'ipv4',
]
)
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'dns',
'name',
'dns_ip4',
'query-name',
'vyos.io',
]
)
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'dns',
'name',
'dns_ip4',
'query-type',
'A',
]
)
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'icmp',
'name',
'icmp_ip6',
'preferred-ip-protocol',
'ipv6',
]
)
# commit changes
self.cli_commit()
file_content = read_file(blackbox_exporter_service_file)
self.assertIn(f'{listen_ip}:9115', file_content)
# Check for running process
self.assertTrue(process_named_running(BLACKBOX_EXPORTER_PROCESS_NAME))
def test_05_blackbox_exporter_with_icmp(self):
vrf_name = 'bbx'
be_path = base_path + ['blackbox-exporter']
self.cli_set(be_path + ['listen-address', listen_ip])
self.cli_set(
be_path
+ ['modules', 'icmp', 'name', 'ping4', 'preferred-ip-protocol', 'ipv4']
)
self.cli_commit()
# Verify CAP_NET_RAW is granted when ICMP module is configured (no VRF case)
file_content = read_file(blackbox_exporter_service_file)
self.assertIn('AmbientCapabilities=CAP_NET_RAW', file_content)
self.assertIn('CapabilityBoundingSet=CAP_NET_RAW', file_content)
# Check for running process
self.assertTrue(process_named_running(BLACKBOX_EXPORTER_PROCESS_NAME))
self.cli_delete(be_path + ['modules', 'icmp'])
self.cli_commit()
# Verify CAP_NET_RAW is removed when ICMP module is deleted
file_content = read_file(blackbox_exporter_service_file)
self.assertNotIn('CAP_NET_RAW', file_content)
self.assertTrue(process_named_running(BLACKBOX_EXPORTER_PROCESS_NAME))
# VRF + ICMP should use setpriv with net_raw capabilities
self.cli_set(['vrf', 'name', vrf_name, 'table', '1111'])
self.cli_set(be_path + ['vrf', vrf_name])
self.cli_set(
be_path
+ ['modules', 'icmp', 'name', 'ping4', 'preferred-ip-protocol', 'ipv4']
)
self.cli_commit()
# Verify VRF uses setpriv instead of systemd capabilities
file_content = read_file(blackbox_exporter_service_file)
self.assertIn('setpriv', file_content)
self.assertIn('--ambient-caps=+net_raw', file_content)
self.assertIn('--inh-caps=+net_raw', file_content)
self.assertNotIn('AmbientCapabilities=CAP_NET_RAW', file_content)
# Cleanup VRF
self.cli_delete(['vrf', 'name', vrf_name])
if __name__ == '__main__':
unittest.main(verbosity=2, failfast=VyOSUnitTestSHIM.TestCase.debug_on())
|
