test/test_syslog.py

   1 #!/usr/bin/env python
   2
   3 import unittest
   4 from framework import VppTestCase, VppTestRunner
   5 from util import ppp
   6 from scapy.packet import Raw
   7 from scapy.layers.inet import IP, UDP
   8 from vpp_papi_provider import SYSLOG_SEVERITY
   9 from syslog_rfc5424_parser import SyslogMessage, ParseError
  10 from syslog_rfc5424_parser.constants import SyslogFacility, SyslogSeverity
  11
  12
  13 class TestSyslog(VppTestCase):
  14     """ Syslog Protocol Test Cases """
  15
  16     @classmethod
  17     def setUpClass(cls):
  18         super(TestSyslog, cls).setUpClass()
  19
  20         try:
  21             cls.create_pg_interfaces(range(1))
  22             cls.pg0.admin_up()
  23             cls.pg0.config_ip4()
  24             cls.pg0.resolve_arp()
  25
  26         except Exception:
  27             super(TestSyslog, cls).tearDownClass()
  28             raise
  29
  30     def syslog_generate(self, facility, severity, appname, msgid, sd=None,
  31                         msg=None):
  32         """
  33         Generate syslog message
  34
  35         :param facility: facility value
  36         :param severity: severity level
  37         :param appname: application name that originate message
  38         :param msgid: message indetifier
  39         :param sd: structured data (optional)
  40         :param msg: free-form message (optional)
  41         """
  42         facility_str = ['kernel', 'user-level', 'mail-system',
  43                         'system-daemons', 'security-authorization', 'syslogd',
  44                         'line-printer', 'network-news', 'uucp', 'clock-daemon',
  45                         '', 'ftp-daemon', 'ntp-subsystem', 'log-audit',
  46                         'log-alert', '', 'local0', 'local1', 'local2',
  47                         'local3', 'local4', 'local5', 'local6', 'local7']
  48
  49         severity_str = ['emergency', 'alert', 'critical', 'error', 'warning',
  50                         'notice', 'informational', 'debug']
  51
  52         cli_str = "test syslog %s %s %s %s" % (facility_str[facility],
  53                                                severity_str[severity],
  54                                                appname,
  55                                                msgid)
  56         if sd is not None:
  57             for sd_id, sd_params in sd.items():
  58                 cli_str += " sd-id %s" % (sd_id)
  59                 for name, value in sd_params.items():
  60                     cli_str += " sd-param %s %s" % (name, value)
  61         if msg is not None:
  62             cli_str += " %s" % (msg)
  63         self.vapi.cli(cli_str)
  64
  65     def syslog_verify(self, data, facility, severity, appname, msgid, sd=None,
  66                       msg=None):
  67         """
  68         Verify syslog message
  69
  70         :param data: syslog message
  71         :param facility: facility value
  72         :param severity: severity level
  73         :param appname: application name that originate message
  74         :param msgid: message indetifier
  75         :param sd: structured data (optional)
  76         :param msg: free-form message (optional)
  77         """
  78         message = data.decode('utf-8')
  79         if sd is None:
  80             sd = {}
  81         try:
  82             message = SyslogMessage.parse(message)
  83             self.assertEqual(message.facility, facility)
  84             self.assertEqual(message.severity, severity)
  85             self.assertEqual(message.appname, appname)
  86             self.assertEqual(message.msgid, msgid)
  87             self.assertEqual(message.msg, msg)
  88             self.assertEqual(message.sd, sd)
  89             self.assertEqual(message.version, 1)
  90             self.assertEqual(message.hostname, self.pg0.local_ip4)
  91         except ParseError as e:
  92             self.logger.error(e)
  93
  94     def test_syslog(self):
  95         """ Syslog Protocol test """
  96         self.vapi.syslog_set_sender(self.pg0.remote_ip4n, self.pg0.local_ip4n)
  97         config = self.vapi.syslog_get_sender()
  98         self.assertEqual(str(config.collector_address),
  99                          self.pg0.remote_ip4)
 100         self.assertEqual(config.collector_port, 514)
 101         self.assertEqual(str(config.src_address), self.pg0.local_ip4)
 102         self.assertEqual(config.vrf_id, 0)
 103         self.assertEqual(config.max_msg_size, 480)
 104
 105         appname = 'test'
 106         msgid = 'testMsg'
 107         msg = 'this is message'
 108         sd1 = {'exampleSDID@32473': {'iut': '3',
 109                                      'eventSource': 'App',
 110                                      'eventID': '1011'}}
 111         sd2 = {'exampleSDID@32473': {'iut': '3',
 112                                      'eventSource': 'App',
 113                                      'eventID': '1011'},
 114                'examplePriority@32473': {'class': 'high'}}
 115
 116         self.pg_enable_capture(self.pg_interfaces)
 117         self.syslog_generate(SyslogFacility.local7,
 118                              SyslogSeverity.info,
 119                              appname,
 120                              msgid,
 121                              None,
 122                              msg)
 123         capture = self.pg0.get_capture(1)
 124         try:
 125             self.assertEqual(capture[0][IP].src, self.pg0.local_ip4)
 126             self.assertEqual(capture[0][IP].dst, self.pg0.remote_ip4)
 127             self.assertEqual(capture[0][UDP].dport, 514)
 128             self.assert_packet_checksums_valid(capture[0], False)
 129         except:
 130                 self.logger.error(ppp("invalid packet:", capture[0]))
 131                 raise
 132         self.syslog_verify(capture[0][Raw].load,
 133                            SyslogFacility.local7,
 134                            SyslogSeverity.info,
 135                            appname,
 136                            msgid,
 137                            None,
 138                            msg)
 139
 140         self.pg_enable_capture(self.pg_interfaces)
 141         self.vapi.syslog_set_filter(SYSLOG_SEVERITY.WARN)
 142         filter = self.vapi.syslog_get_filter()
 143         self.assertEqual(filter.severity, SYSLOG_SEVERITY.WARN)
 144         self.syslog_generate(SyslogFacility.local7,
 145                              SyslogSeverity.info,
 146                              appname,
 147                              msgid,
 148                              None,
 149                              msg)
 150         self.pg0.assert_nothing_captured()
 151
 152         self.pg_enable_capture(self.pg_interfaces)
 153         self.syslog_generate(SyslogFacility.local6,
 154                              SyslogSeverity.warning,
 155                              appname,
 156                              msgid,
 157                              sd1,
 158                              msg)
 159         capture = self.pg0.get_capture(1)
 160         self.syslog_verify(capture[0][Raw].load,
 161                            SyslogFacility.local6,
 162                            SyslogSeverity.warning,
 163                            appname,
 164                            msgid,
 165                            sd1,
 166                            msg)
 167
 168         self.vapi.syslog_set_sender(self.pg0.remote_ip4n,
 169                                     self.pg0.local_ip4n,
 170                                     collector_port=12345)
 171         config = self.vapi.syslog_get_sender()
 172         self.assertEqual(config.collector_port, 12345)
 173
 174         self.pg_enable_capture(self.pg_interfaces)
 175         self.syslog_generate(SyslogFacility.local5,
 176                              SyslogSeverity.err,
 177                              appname,
 178                              msgid,
 179                              sd2,
 180                              None)
 181         capture = self.pg0.get_capture(1)
 182         try:
 183             self.assertEqual(capture[0][UDP].dport, 12345)
 184         except:
 185                 self.logger.error(ppp("invalid packet:", capture[0]))
 186                 raise
 187         self.syslog_verify(capture[0][Raw].load,
 188                            SyslogFacility.local5,
 189                            SyslogSeverity.err,
 190                            appname,
 191                            msgid,
 192                            sd2,
 193                            None)
 194
 195
 196 if __name__ == '__main__':
 197     unittest.main(testRunner=VppTestRunner)