File: sfc_port_chain.py

package info (click to toggle)
python-neutronclient 1%3A7.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,868 kB
  • sloc: python: 32,902; sh: 223; makefile: 16
file content (364 lines) | stat: -rwxr-xr-x 14,731 bytes parent folder | download | duplicates (3)
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# Copyright (c) 2017 Huawei Technologies India Pvt.Limited.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import logging

from osc_lib.cli import parseractions
from osc_lib.command import command
from osc_lib import exceptions
from osc_lib import utils
from osc_lib.utils import columns as column_util

from neutronclient._i18n import _

LOG = logging.getLogger(__name__)

resource = 'port_chain'

_attr_map = (
    ('id', 'ID', column_util.LIST_BOTH),
    ('name', 'Name', column_util.LIST_BOTH),
    ('port_pair_groups', 'Port Pair Groups', column_util.LIST_BOTH),
    ('flow_classifiers', 'Flow Classifiers',
     column_util.LIST_BOTH),
    ('chain_parameters', 'Chain Parameters',
     column_util.LIST_BOTH),
    ('description', 'Description', column_util.LIST_LONG_ONLY),
    ('chain_id', 'Chain ID',  column_util.LIST_BOTH),
    ('project_id', 'Project', column_util.LIST_LONG_ONLY),
)


class CreateSfcPortChain(command.ShowOne):
    _description = _("Create a port chain")

    def get_parser(self, prog_name):
        parser = super(CreateSfcPortChain, self).get_parser(prog_name)
        parser.add_argument(
            'name',
            metavar='<name>',
            help=_('Name of the port chain'))
        parser.add_argument(
            '--description',
            metavar='<description>',
            help=_('Description for the port chain'))
        parser.add_argument(
            '--flow-classifier',
            default=[],
            metavar='<flow-classifier>',
            dest='flow_classifiers',
            action='append',
            help=_('Add flow classifier (name or ID). '
                   'This option can be repeated.'))
        parser.add_argument(
            '--chain-parameters',
            metavar='correlation=<correlation-type>,symmetric=<boolean>',
            action=parseractions.MultiKeyValueAction,
            optional_keys=['correlation', 'symmetric'],
            help=_('Dictionary of chain parameters. Supports '
                   'correlation=(mpls|nsh) (default is mpls) '
                   'and symmetric=(true|false).'))
        parser.add_argument(
            '--port-pair-group',
            metavar='<port-pair-group>',
            dest='port_pair_groups',
            required=True,
            action='append',
            help=_('Add port pair group (name or ID). '
                   'This option can be repeated.'))
        return parser

    def take_action(self, parsed_args):
        client = self.app.client_manager.neutronclient
        attrs = _get_common_attrs(self.app.client_manager, parsed_args)
        body = {resource: attrs}
        obj = client.create_sfc_port_chain(body)[resource]
        columns, display_columns = column_util.get_columns(obj, _attr_map)
        data = utils.get_dict_properties(obj, columns)
        return display_columns, data


class DeleteSfcPortChain(command.Command):
    _description = _("Delete a given port chain")

    def get_parser(self, prog_name):
        parser = super(DeleteSfcPortChain, self).get_parser(prog_name)
        parser.add_argument(
            'port_chain',
            metavar="<port-chain>",
            help=_("Port chain to delete (name or ID)")
        )
        return parser

    def take_action(self, parsed_args):
        # TODO(mohan): Add support for deleting multiple resources.
        client = self.app.client_manager.neutronclient
        pc_id = _get_id(client, parsed_args.port_chain, resource)
        try:
            client.delete_sfc_port_chain(pc_id)
        except Exception as e:
            msg = (_("Failed to delete port chain with name "
                     "or ID '%(pc)s': %(e)s")
                   % {'pc': parsed_args.port_chain, 'e': e})
            raise exceptions.CommandError(msg)


class ListSfcPortChain(command.Lister):
    _description = _("List port chains")

    def get_parser(self, prog_name):
        parser = super(ListSfcPortChain, self).get_parser(prog_name)
        parser.add_argument(
            '--long',
            action='store_true',
            default=False,
            help=_("List additional fields in output")
        )
        return parser

    def take_action(self, parsed_args):
        client = self.app.client_manager.neutronclient
        data = client.list_sfc_port_chains()
        headers, columns = column_util.get_column_definitions(
            _attr_map, long_listing=parsed_args.long)
        return (headers,
                (utils.get_dict_properties(s, columns)
                 for s in data['port_chains']))


class SetSfcPortChain(command.Command):
    _description = _("Set port chain properties")

    def get_parser(self, prog_name):
        parser = super(SetSfcPortChain, self).get_parser(prog_name)
        parser.add_argument(
            '--name',
            metavar='<name>',
            help=_('Name of the port chain'))
        parser.add_argument(
            '--description',
            metavar='<description>',
            help=_('Description for the port chain'))
        parser.add_argument(
            '--flow-classifier',
            metavar='<flow-classifier>',
            dest='flow_classifiers',
            action='append',
            help=_('Add flow classifier (name or ID). '
                   'This option can be repeated.'))
        parser.add_argument(
            '--no-flow-classifier',
            action='store_true',
            help=_('Remove associated flow classifiers from the port chain'))
        parser.add_argument(
            '--port-pair-group',
            metavar='<port-pair-group>',
            dest='port_pair_groups',
            action='append',
            help=_('Add port pair group (name or ID). '
                   'Current port pair groups order is kept, the added port '
                   'pair group will be placed at the end of the port chain. '
                   'This option can be repeated.'))
        parser.add_argument(
            '--no-port-pair-group',
            action='store_true',
            help=_('Remove associated port pair groups from the port chain. '
                   'At least one --port-pair-group must be specified '
                   'together.'))
        parser.add_argument(
            'port_chain',
            metavar='<port-chain>',
            help=_("Port chain to modify (name or ID)"))
        return parser

    def take_action(self, parsed_args):
        client = self.app.client_manager.neutronclient
        pc_id = _get_id(client, parsed_args.port_chain, resource)
        attrs = _get_common_attrs(self.app.client_manager, parsed_args,
                                  is_create=False)
        if parsed_args.no_flow_classifier:
            attrs['flow_classifiers'] = []
        if parsed_args.flow_classifiers:
            if parsed_args.no_flow_classifier:
                fc_list = []
            else:
                fc_list = client.find_resource(
                    resource, parsed_args.port_chain,
                    cmd_resource='sfc_port_chain')['flow_classifiers']
            for fc in parsed_args.flow_classifiers:
                fc_id = client.find_resource(
                    'flow_classifier', fc,
                    cmd_resource='sfc_flow_classifier')['id']
                if fc_id not in fc_list:
                    fc_list.append(fc_id)
            attrs['flow_classifiers'] = fc_list
        if (parsed_args.no_port_pair_group and not
                parsed_args.port_pair_groups):
            message = _('At least one --port-pair-group must be specified.')
            raise exceptions.CommandError(message)
        if parsed_args.no_port_pair_group and parsed_args.port_pair_groups:
            ppg_list = []
            for ppg in parsed_args.port_pair_groups:
                ppg_id = client.find_resource(
                    'port_pair_group', ppg,
                    cmd_resource='sfc_port_pair_group')['id']
                if ppg_id not in ppg_list:
                    ppg_list.append(ppg_id)
            attrs['port_pair_groups'] = ppg_list
        if (parsed_args.port_pair_groups and
                not parsed_args.no_port_pair_group):
            ppg_list = client.find_resource(
                resource, parsed_args.port_chain,
                cmd_resource='sfc_port_chain')['port_pair_groups']
            for ppg in parsed_args.port_pair_groups:
                ppg_id = client.find_resource(
                    'port_pair_group', ppg,
                    cmd_resource='sfc_port_pair_group')['id']
                if ppg_id not in ppg_list:
                    ppg_list.append(ppg_id)
            attrs['port_pair_groups'] = ppg_list
        body = {resource: attrs}
        try:
            client.update_sfc_port_chain(pc_id, body)
        except Exception as e:
            msg = (_("Failed to update port chain '%(pc)s': %(e)s")
                   % {'pc': parsed_args.port_chain, 'e': e})
            raise exceptions.CommandError(msg)


class ShowSfcPortChain(command.ShowOne):
    _description = _("Display port chain details")

    def get_parser(self, prog_name):
        parser = super(ShowSfcPortChain, self).get_parser(prog_name)
        parser.add_argument(
            'port_chain',
            metavar="<port-chain>",
            help=_("Port chain to display (name or ID)")
        )
        return parser

    def take_action(self, parsed_args):
        client = self.app.client_manager.neutronclient
        pc_id = _get_id(client, parsed_args.port_chain, resource)
        obj = client.show_sfc_port_chain(pc_id)[resource]
        columns, display_columns = column_util.get_columns(obj, _attr_map)
        data = utils.get_dict_properties(obj, columns)
        return display_columns, data


class UnsetSfcPortChain(command.Command):
    _description = _("Unset port chain properties")

    def get_parser(self, prog_name):
        parser = super(UnsetSfcPortChain, self).get_parser(prog_name)
        parser.add_argument(
            'port_chain',
            metavar='<port-chain>',
            help=_("Port chain to unset (name or ID)"))
        port_chain = parser.add_mutually_exclusive_group()
        port_chain.add_argument(
            '--flow-classifier',
            action='append',
            metavar='<flow-classifier>',
            dest='flow_classifiers',
            help=_('Remove flow classifier(s) from the port chain '
                   '(name or ID). This option can be repeated.'))
        port_chain.add_argument(
            '--all-flow-classifier',
            action='store_true',
            help=_('Remove all flow classifiers from the port chain'))
        parser.add_argument(
            '--port-pair-group',
            metavar='<port-pair-group>',
            dest='port_pair_groups',
            action='append',
            help=_('Remove port pair group(s) from the port chain '
                   '(name or ID). This option can be repeated.'))
        return parser

    def take_action(self, parsed_args):
        client = self.app.client_manager.neutronclient
        pc_id = _get_id(client, parsed_args.port_chain, resource)
        attrs = {}
        if parsed_args.flow_classifiers:
            fc_list = client.find_resource(
                resource, parsed_args.port_chain,
                cmd_resource='sfc_port_chain')['flow_classifiers']
            for fc in parsed_args.flow_classifiers:
                fc_id = client.find_resource(
                    'flow_classifier', fc,
                    cmd_resource='sfc_flow_classifier')['id']
                if fc_id in fc_list:
                    fc_list.remove(fc_id)
            attrs['flow_classifiers'] = fc_list
        if parsed_args.all_flow_classifier:
            attrs['flow_classifiers'] = []
        if parsed_args.port_pair_groups:
            ppg_list = client.find_resource(
                resource, parsed_args.port_chain,
                cmd_resource='sfc_port_chain')['port_pair_groups']
            for ppg in parsed_args.port_pair_groups:
                ppg_id = client.find_resource(
                    'port_pair_group', ppg,
                    cmd_resource='sfc_port_pair_group')['id']
                if ppg_id in ppg_list:
                    ppg_list.remove(ppg_id)
            if ppg_list == []:
                message = _('At least one port pair group must be'
                            ' specified.')
                raise exceptions.CommandError(message)
            attrs['port_pair_groups'] = ppg_list
        body = {resource: attrs}
        try:
            client.update_sfc_port_chain(pc_id, body)
        except Exception as e:
            msg = (_("Failed to unset port chain '%(pc)s': %(e)s")
                   % {'pc': parsed_args.port_chain, 'e': e})
            raise exceptions.CommandError(msg)


def _get_common_attrs(client_manager, parsed_args, is_create=True):
    attrs = {}
    if parsed_args.name is not None:
        attrs['name'] = parsed_args.name
    if parsed_args.description is not None:
        attrs['description'] = parsed_args.description
    if parsed_args.port_pair_groups:
        attrs['port_pair_groups'] = [(_get_id(client_manager.neutronclient,
                                              ppg, 'port_pair_group'))
                                     for ppg in parsed_args.port_pair_groups]
    if parsed_args.flow_classifiers:
        attrs['flow_classifiers'] = [(_get_id(client_manager.neutronclient, fc,
                                      'flow_classifier'))
                                     for fc in parsed_args.flow_classifiers]
    if is_create is True:
        _get_attrs(attrs, parsed_args)
    return attrs


def _get_attrs(attrs, parsed_args):
    if parsed_args.chain_parameters is not None:
        chain_params = {}
        for chain_param in parsed_args.chain_parameters:
            if 'correlation' in chain_param:
                chain_params['correlation'] = chain_param['correlation']
            if 'symmetric' in chain_param:
                chain_params['symmetric'] = chain_param['symmetric']
        attrs['chain_parameters'] = chain_params


def _get_id(client, id_or_name, resource):
    return client.find_resource(resource, id_or_name)['id']