summaryrefslogtreecommitdiff
path: root/smoketest/scripts/cli/test_system_sflow.py
blob: 700253e2b94672dd599d33686987bf2577bdad12 (plain)
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
#!/usr/bin/env python3
#
# Copyright (C) 2023-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 unittest

from base_vyostest_shim import VyOSUnitTestSHIM

from vyos.configsession import ConfigSessionError
from vyos.ifconfig import Section
from vyos.utils.process import cmd
from vyos.utils.process import process_named_running
from vyos.utils.file import read_file

PROCESS_NAME = 'hsflowd'
base_path = ['system', 'sflow']
vrf = 'mgmt'

hsflowd_conf = '/run/sflow/hsflowd.conf'

class TestSystemFlowAccounting(VyOSUnitTestSHIM.TestCase):
    @classmethod
    def setUpClass(cls):
        super(TestSystemFlowAccounting, 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):
        # after service removal process must no longer run
        self.assertTrue(process_named_running(PROCESS_NAME))

        self.cli_delete(base_path)
        self.cli_delete(['vrf', 'name', vrf])
        self.cli_commit()

        # after service removal process must no longer run
        self.assertFalse(process_named_running(PROCESS_NAME))

    def test_sflow(self):
        agent_address = '192.0.2.5'
        agent_interface = 'eth0'
        polling = '24'
        sampling_rate = '128'
        server = '192.0.2.254'
        local_server = '127.0.0.1'
        port = '8192'
        default_port = '6343'
        mon_limit = '50'

        self.cli_set(
            ['interfaces', 'dummy', 'dum0', 'address', f'{agent_address}/24'])
        self.cli_set(base_path + ['agent-address', agent_address])
        self.cli_set(base_path + ['agent-interface', agent_interface])

        # You need to configure at least one interface for sflow
        with self.assertRaises(ConfigSessionError):
            self.cli_commit()
        for interface in Section.interfaces('ethernet'):
            self.cli_set(base_path + ['interface', interface])

        self.cli_set(base_path + ['polling', polling])
        self.cli_set(base_path + ['sampling-rate', sampling_rate])
        self.cli_set(base_path + ['server', server, 'port', port])
        self.cli_set(base_path + ['server', local_server])
        self.cli_set(base_path + ['drop-monitor-limit', mon_limit])

        # commit changes
        self.cli_commit()

        # verify configuration
        hsflowd = read_file(hsflowd_conf)

        self.assertIn(f'polling={polling}', hsflowd)
        self.assertIn(f'sampling={sampling_rate}', hsflowd)
        self.assertIn(f'agentIP={agent_address}', hsflowd)
        self.assertIn(f'agent={agent_interface}', hsflowd)
        self.assertIn(f'collector {{ ip = {server} udpport = {port} }}', hsflowd)
        self.assertIn(f'collector {{ ip = {local_server} udpport = {default_port} }}', hsflowd)
        self.assertIn(f'dropmon {{ limit={mon_limit} start=on sw=on hw=off }}', hsflowd)
        self.assertIn('dbus { }', hsflowd)

        for interface in Section.interfaces('ethernet'):
            self.assertIn(f'pcap {{ dev={interface} }}', hsflowd)

    def test_sflow_ipv6(self):
        sampling_rate = '100'
        default_polling = '30'
        default_port = '6343'
        sflow_server = {
            '2001:db8::1': {},
            '2001:db8::2': {'port': '8023'},
        }

        for interface in Section.interfaces('ethernet'):
            self.cli_set(base_path + ['interface', interface])

        self.cli_set(base_path + ['sampling-rate', sampling_rate])
        for server, server_config in sflow_server.items():
            self.cli_set(base_path + ['server', server])
            if 'port' in server_config:
                self.cli_set(base_path + ['server', server, 'port', server_config['port']])

        # commit changes
        self.cli_commit()

        # verify configuration
        hsflowd = read_file(hsflowd_conf)

        self.assertIn(f'sampling={sampling_rate}', hsflowd)
        self.assertIn(f'polling={default_polling}', hsflowd)

        for server, server_config in sflow_server.items():
            if 'port' in server_config:
                self.assertIn(f'collector {{ ip = {server} udpport = {server_config["port"]} }}', hsflowd)
            else:
                self.assertIn(f'collector {{ ip = {server} udpport = {default_port} }}', hsflowd)

    def test_vrf(self):
        interface = 'eth0'
        server = '192.0.2.1'

        # Check if sFlow service can be bound to given VRF
        self.cli_set(['vrf', 'name', vrf, 'table', '10100'])
        self.cli_set(base_path + ['interface', interface])
        self.cli_set(base_path + ['server', server])
        self.cli_set(base_path + ['vrf', vrf])

        # commit changes
        self.cli_commit()

        # verify configuration
        hsflowd = read_file(hsflowd_conf)
        self.assertIn(f'collector {{ ip = {server} udpport = 6343 }}', hsflowd) # default port
        self.assertIn(f'pcap {{ dev=eth0 }}', hsflowd)

        # Check for process in VRF
        tmp = cmd(f'ip vrf pids {vrf}')
        self.assertIn(PROCESS_NAME, tmp)

if __name__ == '__main__':
    unittest.main(verbosity=2)