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
|
#!/usr/bin/env python3
#
# Copyright (C) 2019-2024 VyOS maintainers and contributors
#
# 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 re
import unittest
from base_vyostest_shim import VyOSUnitTestSHIM
from vyos.utils.file import read_file
from vyos.utils.process import process_named_running
from vyos.xml_ref import default_value
PROCESS_NAME = 'rsyslogd'
RSYSLOG_CONF = '/etc/rsyslog.d/00-vyos.conf'
base_path = ['system', 'syslog']
def get_config_value(key):
tmp = read_file(RSYSLOG_CONF)
tmp = re.findall(r'\n?{}\s+(.*)'.format(key), tmp)
return tmp[0]
class TestRSYSLOGService(VyOSUnitTestSHIM.TestCase):
@classmethod
def setUpClass(cls):
super(TestRSYSLOGService, cls).setUpClass()
# ensure we can also run this test on a live system - so lets clean
# out the current configuration :)
cls.cli_delete(cls, base_path)
def tearDown(self):
# Check for running process
self.assertTrue(process_named_running(PROCESS_NAME))
# delete testing SYSLOG config
self.cli_delete(base_path)
self.cli_commit()
# Check for running process
self.assertFalse(process_named_running(PROCESS_NAME))
def test_syslog_basic(self):
host1 = '127.0.0.10'
host2 = '127.0.0.20'
self.cli_set(base_path + ['host', host1, 'port', '999'])
self.cli_set(base_path + ['host', host1, 'facility', 'all', 'level', 'all'])
self.cli_set(base_path + ['host', host2, 'facility', 'kern', 'level', 'err'])
self.cli_set(base_path + ['console', 'facility', 'all', 'level', 'warning'])
self.cli_commit()
# verify log level and facilities in config file
# *.warning /dev/console
# *.* @198.51.100.1:999
# kern.err @192.0.2.1:514
config = [
get_config_value('\*.\*'),
get_config_value('kern.err'),
get_config_value('\*.warning'),
]
expected = [f'@{host1}:999', f'@{host2}:514', '/dev/console']
for i in range(0, 3):
self.assertIn(expected[i], config[i])
# Check for running process
self.assertTrue(process_named_running(PROCESS_NAME))
def test_syslog_global(self):
hostname = 'vyos123'
domainname = 'example.local'
self.cli_set(['system', 'host-name', hostname])
self.cli_set(['system', 'domain-name', domainname])
self.cli_set(base_path + ['global', 'marker', 'interval', '600'])
self.cli_set(base_path + ['global', 'preserve-fqdn'])
self.cli_set(base_path + ['global', 'facility', 'kern', 'level', 'err'])
self.cli_commit()
config = read_file(RSYSLOG_CONF)
expected = [
'$MarkMessagePeriod 600',
'$PreserveFQDN on',
'kern.err',
f'$LocalHostName {hostname}.{domainname}',
]
for e in expected:
self.assertIn(e, config)
# Check for running process
self.assertTrue(process_named_running(PROCESS_NAME))
def test_syslog_remote(self):
rhost = '169.254.0.1'
default_port = default_value(base_path + ['host', rhost, 'port'])
self.cli_set(base_path + ['global', 'facility', 'all', 'level', 'info'])
self.cli_set(base_path + ['global', 'facility', 'local7', 'level', 'debug'])
self.cli_set(base_path + ['host', rhost, 'facility', 'all', 'level', 'all'])
self.cli_set(base_path + ['host', rhost, 'protocol', 'tcp'])
self.cli_commit()
config = read_file(RSYSLOG_CONF)
self.assertIn(f'*.* @@{rhost}:{default_port}', config)
# Change default port and enable "octet-counting" mode
port = '10514'
self.cli_set(base_path + ['host', rhost, 'port', port])
self.cli_set(base_path + ['host', rhost, 'format', 'octet-counted'])
self.cli_commit()
config = read_file(RSYSLOG_CONF)
self.assertIn(f'*.* @@(o){rhost}:{port}', config)
if __name__ == '__main__':
unittest.main(verbosity=2)
|