summaryrefslogtreecommitdiffstats
path: root/scripts/automation/trex_control_plane/client/trex_stateless_client.py
blob: b7580531d262ed393eba99bb7ecba757f9afd966 (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
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
#!/router/bin/python

try:
    # support import for Python 2
    import outer_packages
except ImportError:
    # support import for Python 3
    import client.outer_packages
from client_utils.jsonrpc_client import JsonRpcClient
from client_utils.packet_builder import CTRexPktBuilder
import json


class CTRexStatelessClient(object):
    """docstring for CTRexStatelessClient"""
    def __init__(self, server="localhost", port=5050, virtual=False):
        super(CTRexStatelessClient, self).__init__()
        self.tx_link = CTRexStatelessClient.CTxLink(server, port, virtual)
        self._conn_handler = {}

    def owned(func):
        def wrapper(self, *args, **kwargs ) :
            if self._conn_handler.get(kwargs.get("port_id")):
                return func(self, *args, **kwargs)
            else:
                raise RuntimeError("The requested method ('{0}') cannot be invoked unless the desired port is owned".
                                   format(func.__name__))
        return wrapper

    def acquire(self, port_id, username, force=False):
        params = {"port_id": port_id,
                  "user": username,
                  "force": force}
        self._conn_handler[port_id] = self.transmit("acquire", params)
        return self._conn_handler

    @owned
    def release(self, port_id=None):
        self._conn_handler.pop(port_id)
        params = {"handler":self._conn_handler.get(port_id),
                  "port_id": port_id}
        return self.transmit("release", params)

    @owned
    def add_stream(self, stream_id, stream_obj, port_id=None):
        assert isinstance(stream_obj, CStream)
        params = {"handler":self._conn_handler.get(port_id),
                  "port_id":port_id,
                  "stream_id":stream_id,
                  "stream":stream_obj.dump()}
        return self.transmit("add_stream", params)

    @owned
    def remove_stream(self, stream_id, port_id=None):
        params = {"handler":self._conn_handler.get(port_id),
                  "port_id":port_id,
                  "stream_id":stream_id}
        return self.transmit("remove_stream", params)

    @owned
    def get_stream_list(self, port_id=None):
        params = {"handler":self._conn_handler.get(port_id),
                  "port_id":port_id}
        return self.transmit("get_stream_list", params)

    @owned
    def get_stream(self, stream_id, port_id=None):
        params = {"handler":self._conn_handler.get(port_id),
                  "port_id":port_id}
        return self.transmit("get_stream_list", params)



    def transmit(self, method_name, params={}):
        return self.tx_link.transmit(method_name, params)


    # ------ private classes ------ #
    class CTxLink(object):
        """describes the connectivity of the stateless client method"""
        def __init__(self, server="localhost", port=5050, virtual=False):
            super(CTRexStatelessClient.CTxLink, self).__init__()
            self.virtual = virtual
            self.server = server
            self.port = port
            self.rpc_link = JsonRpcClient(self.server, self.port)
            if not self.virtual:
                self.rpc_link.connect()

        def transmit(self, method_name, params={}):
            if self.virtual:
                print "Transmitting virtually over tcp://{server}:{port}".format(
                    server=self.server,
                    port=self.port)
                id, msg = self.rpc_link.create_jsonrpc_v2(method_name, params)
                print msg
                return
            else:
                return self.rpc_link.invoke_rpc_method(method_name, params)

class CStream(object):
    """docstring for CStream"""
    DEFAULTS = {"rx_stats": CRxStats,
                "mode": CTxMode,
                "isg": 5.0,
                "next_stream": -1,
                "self_start": True,
                "enabled": True}

    def __init__(self, **kwargs):
        super(CStream, self).__init__()
        for k, v in kwargs.items():
            setattr(self, k, v)
        # set default values to unset attributes, according to DEFAULTS dict
        set_keys = set(kwargs.keys())
        keys_to_set = [x for x in self.DEFAULTS if x not in set_keys]
        for key in keys_to_set:
            default = self.DEFAULTS.get(key)
            if type(default)==type:
                setattr(self, key, default())
            else:
                setattr(self, key, default)

    @property
    def packet(self):
        return self._packet

    @packet.setter
    def packet(self, packet_obj):
        assert isinstance(packet_obj, CTRexPktBuilder)
        self._packet = packet_obj

    @property
    def enabled(self):
        return self._enabled

    @enabled.setter
    def enabled(self, bool_value):
        self._enabled = bool(bool_value)

    @property
    def self_start(self):
        return self._self_start

    @self_start.setter
    def self_start(self, bool_value):
        self._self_start = bool(bool_value)

    @property
    def next_stream(self):
        return self._next_stream

    @next_stream.setter
    def next_stream(self, value):
        self._next_stream = int(value)

    def dump(self):
        pass
        return {"enabled":self.enabled,
                "self_start":self.self_start,
                "isg":self.isg,
                "next_stream":self.next_stream,
                "packet":self.packet.dump_pkt(),
                "mode":self.mode.dump(),
                "vm":self.packet.get_vm_data(),
                "rx_stats":self.rx_stats.dump()}

class CRxStats(object):

    def __init__(self, enabled=False, seq_enabled=False, latency_enabled=False):
        self._rx_dict = {"enabled" : enabled,
                         "seq_enabled" : seq_enabled,
                         "latency_enabled" : latency_enabled}

    @property
    def enabled(self):
        return self._rx_dict.get("enabled")

    @enabled.setter
    def enabled(self, bool_value):
        self._rx_dict['enabled'] = bool(bool_value)

    @property
    def seq_enabled(self):
        return self._rx_dict.get("seq_enabled")

    @seq_enabled.setter
    def seq_enabled(self, bool_value):
        self._rx_dict['seq_enabled'] = bool(bool_value)

    @property
    def latency_enabled(self):
        return self._rx_dict.get("latency_enabled")

    @latency_enabled.setter
    def latency_enabled(self, bool_value):
        self._rx_dict['latency_enabled'] = bool(bool_value)

    def dump(self):
        return {k:v
                for k,v in self._rx_dict.items()
                if v
                }

class CTxMode(object):
    """docstring for CTxMode"""
    def __init__(self, tx_mode, pps):
        super(CTxMode, self).__init__()
        if tx_mode not in ["continuous", "single_burst", "multi_burst"]:
            raise ValueError("Unknown TX mode ('{0}')has been initialized.".format(tx_mode))
        self._tx_mode = tx_mode
        self._fields = {'pps':float(pps)}
        if tx_mode == "single_burst":
            self._fields['total_pkts'] = 0
        elif tx_mode == "multi_burst":
            self._fields['pkts_per_burst'] = 0
            self._fields['ibg'] = 0.0
            self._fields['count'] = 0
        else:
            pass

    def set_tx_mode_attr(self, attr, val):
        if attr in self._fields:
            self._fields[attr] = type(self._fields.get(attr))(val)
        else:
            raise ValueError("The provided attribute ('{0}') is not a legal attribute in selected TX mode ('{1}')".
                format(attr, self._tx_mode))

    def dump(self):
        dump = {"type":self._tx_mode}
        dump.update({k:v
                     for k, v in self._fields.items()
                     })
        return dump


if __name__ == "__main__":
    pass