4 from framework import VppTestCase, VppTestRunner
6 from scapy.packet import Raw
7 from scapy.layers.inet import IP, UDP
8 from syslog_rfc5424_parser import SyslogMessage, ParseError
9 from syslog_rfc5424_parser.constants import SyslogFacility, SyslogSeverity
10 from vpp_papi import VppEnum
13 class TestSyslog(VppTestCase):
14 """Syslog Protocol Test Cases"""
17 def SYSLOG_SEVERITY(self):
18 return VppEnum.vl_api_syslog_severity_t
22 super(TestSyslog, cls).setUpClass()
25 (cls.pg0,) = cls.create_pg_interfaces(range(1))
31 super(TestSyslog, cls).tearDownClass()
35 def tearDownClass(cls):
36 super(TestSyslog, cls).tearDownClass()
38 def syslog_generate(self, facility, severity, appname, msgid, sd=None, msg=None):
40 Generate syslog message
42 :param facility: facility value
43 :param severity: severity level
44 :param appname: application name that originate message
45 :param msgid: message identifier
46 :param sd: structured data (optional)
47 :param msg: free-form message (optional)
54 "security-authorization",
87 cli_str = "test syslog %s %s %s %s" % (
88 facility_str[facility],
89 severity_str[severity],
94 for sd_id, sd_params in sd.items():
95 cli_str += " sd-id %s" % (sd_id)
96 for name, value in sd_params.items():
97 cli_str += " sd-param %s %s" % (name, value)
99 cli_str += " %s" % (msg)
100 self.vapi.cli(cli_str)
103 self, data, facility, severity, appname, msgid, sd=None, msg=None
106 Verify syslog message
108 :param data: syslog message
109 :param facility: facility value
110 :param severity: severity level
111 :param appname: application name that originate message
112 :param msgid: message identifier
113 :param sd: structured data (optional)
114 :param msg: free-form message (optional)
116 message = data.decode("utf-8")
120 message = SyslogMessage.parse(message)
121 except ParseError as e:
125 self.assertEqual(message.facility, facility)
126 self.assertEqual(message.severity, severity)
127 self.assertEqual(message.appname, appname)
128 self.assertEqual(message.msgid, msgid)
129 self.assertEqual(message.msg, msg)
130 self.assertEqual(message.sd, sd)
131 self.assertEqual(message.version, 1)
132 self.assertEqual(message.hostname, self.pg0.local_ip4)
134 def test_syslog(self):
135 """Syslog Protocol test"""
136 self.vapi.syslog_set_sender(
137 src_address=self.pg0.local_ip4, collector_address=self.pg0.remote_ip4
139 config = self.vapi.syslog_get_sender()
140 self.assertEqual(str(config.collector_address), self.pg0.remote_ip4)
141 self.assertEqual(config.collector_port, 514)
142 self.assertEqual(str(config.src_address), self.pg0.local_ip4)
143 self.assertEqual(config.vrf_id, 0)
144 self.assertEqual(config.max_msg_size, 480)
148 msg = "this is message"
150 "exampleSDID@32473": {"iut": "3", "eventSource": "App", "eventID": "1011"}
153 "exampleSDID@32473": {"iut": "3", "eventSource": "App", "eventID": "1011"},
154 "examplePriority@32473": {"class": "high"},
157 self.pg_enable_capture(self.pg_interfaces)
158 self.syslog_generate(
159 SyslogFacility.local7, SyslogSeverity.info, appname, msgid, None, msg
161 capture = self.pg0.get_capture(1)
163 self.assertEqual(capture[0][IP].src, self.pg0.local_ip4)
164 self.assertEqual(capture[0][IP].dst, self.pg0.remote_ip4)
165 self.assertEqual(capture[0][UDP].dport, 514)
166 self.assert_packet_checksums_valid(capture[0], False)
168 self.logger.error(ppp("invalid packet:", capture[0]))
171 capture[0][Raw].load,
172 SyslogFacility.local7,
180 self.pg_enable_capture(self.pg_interfaces)
181 self.vapi.syslog_set_filter(self.SYSLOG_SEVERITY.SYSLOG_API_SEVERITY_WARN)
182 filter = self.vapi.syslog_get_filter()
183 self.assertEqual(filter.severity, self.SYSLOG_SEVERITY.SYSLOG_API_SEVERITY_WARN)
184 self.syslog_generate(
185 SyslogFacility.local7, SyslogSeverity.info, appname, msgid, None, msg
187 self.pg0.assert_nothing_captured()
189 self.pg_enable_capture(self.pg_interfaces)
190 self.syslog_generate(
191 SyslogFacility.local6, SyslogSeverity.warning, appname, msgid, sd1, msg
193 capture = self.pg0.get_capture(1)
195 capture[0][Raw].load,
196 SyslogFacility.local6,
197 SyslogSeverity.warning,
204 self.vapi.syslog_set_sender(
205 self.pg0.local_ip4, self.pg0.remote_ip4, collector_port=12345
207 config = self.vapi.syslog_get_sender()
208 self.assertEqual(config.collector_port, 12345)
210 self.pg_enable_capture(self.pg_interfaces)
211 self.syslog_generate(
212 SyslogFacility.local5, SyslogSeverity.err, appname, msgid, sd2, None
214 capture = self.pg0.get_capture(1)
216 self.assertEqual(capture[0][UDP].dport, 12345)
218 self.logger.error(ppp("invalid packet:", capture[0]))
221 capture[0][Raw].load,
222 SyslogFacility.local5,
231 if __name__ == "__main__":
232 unittest.main(testRunner=VppTestRunner)