File: test_default_security_group_rules.py

package info (click to toggle)
neutron-tempest-plugin 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,372 kB
  • sloc: python: 26,896; sh: 324; makefile: 24
file content (313 lines) | stat: -rw-r--r-- 12,566 bytes parent folder | download | duplicates (2)
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
# 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 copy
import random

from neutron_lib import constants
from tempest.lib import decorators
from tempest.lib import exceptions as lib_exc

from neutron_tempest_plugin.api import base

RULE_KEYWORDS_TO_CHECK = [
    'direction', 'remote_group_id', 'remote_address_group_id', 'description',
    'protocol', 'port_range_min', 'port_range_max', 'ethertype',
    'remote_ip_prefix', 'used_in_default_sg', 'used_in_non_default_sg'
]


class DefaultSecurityGroupRuleTest(base.BaseAdminNetworkTest):
    required_extensions = ['security-groups-default-rules']

    credentials = ['primary', 'admin']

    @classmethod
    def setup_clients(cls):
        super(DefaultSecurityGroupRuleTest, cls).setup_clients()
        cls.admin_client = cls.os_admin.network_client

    def _filter_not_relevant_rule_keys(self, rule, expected_keys=None):
        expected_keys = expected_keys or RULE_KEYWORDS_TO_CHECK
        new_rule = {}
        for k in rule.keys():
            if k in expected_keys:
                new_rule[k] = rule[k]
        return new_rule

    def _filter_not_relevant_rules_keys(self, rules, keys=None):
        keys = keys or RULE_KEYWORDS_TO_CHECK
        return [self._filter_not_relevant_rule_keys(r, keys) for r in rules]

    def _assert_rules_exists(self, expected_rules, actual_rules):
        for expected_rule in expected_rules:
            self.assertIn(expected_rule, actual_rules)

    @decorators.idempotent_id('2f3d3070-e9fa-4127-a33f-f1532fd89108')
    def test_legacy_default_sg_rules_created_by_default(self):
        expected_legacy_template_rules = [
            {
                'direction': 'egress',
                'ethertype': 'IPv4',
                'remote_group_id': None,
                'protocol': None,
                'remote_ip_prefix': None,
                'remote_address_group_id': None,
                'port_range_max': None,
                'port_range_min': None,
                'used_in_default_sg': True,
                'used_in_non_default_sg': True,
                'description': 'Legacy default SG rule for egress traffic'
            }, {
                'remote_group_id': 'PARENT',
                'direction': 'ingress',
                'ethertype': 'IPv6',
                'protocol': None,
                'remote_ip_prefix': None,
                'remote_address_group_id': None,
                'port_range_max': None,
                'port_range_min': None,
                'used_in_default_sg': True,
                'used_in_non_default_sg': False,
                'description': 'Legacy default SG rule for ingress traffic'
            }, {
                'remote_group_id': 'PARENT',
                'direction': 'ingress',
                'ethertype': 'IPv4',
                'protocol': None,
                'remote_ip_prefix': None,
                'remote_address_group_id': None,
                'port_range_max': None,
                'port_range_min': None,
                'used_in_default_sg': True,
                'used_in_non_default_sg': False,
                'description': 'Legacy default SG rule for ingress traffic'
            }, {
                'direction': 'egress',
                'ethertype': 'IPv6',
                'remote_group_id': None,
                'protocol': None,
                'remote_ip_prefix': None,
                'remote_address_group_id': None,
                'port_range_max': None,
                'port_range_min': None,
                'used_in_default_sg': True,
                'used_in_non_default_sg': True,
                'description': 'Legacy default SG rule for egress traffic'
            }
        ]
        sg_rules_template = (
            self.admin_client.list_default_security_group_rules()[
                'default_security_group_rules'
            ])
        self._assert_rules_exists(
            expected_legacy_template_rules,
            self._filter_not_relevant_rules_keys(sg_rules_template))

    @decorators.idempotent_id('df98f969-ff2d-4597-9765-f5d4f81f775f')
    def test_default_security_group_rule_lifecycle(self):
        tcp_port = random.randint(constants.PORT_RANGE_MIN,
                                  constants.PORT_RANGE_MAX)
        rule_args = {
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'port_range_max': tcp_port,
            'port_range_min': tcp_port,
            'used_in_default_sg': False,
            'used_in_non_default_sg': True,
            'description': (
                'Allow tcp connections over IPv4 on port %s' % tcp_port)
        }
        expected_rule = {
            'remote_group_id': None,
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'port_range_min': tcp_port,
            'port_range_max': tcp_port,
            'remote_ip_prefix': None,
            'remote_address_group_id': None,
            'used_in_default_sg': False,
            'used_in_non_default_sg': True,
            'description': (
                'Allow tcp connections over IPv4 on port %s' % tcp_port)
        }
        created_rule_template = self.create_default_security_group_rule(
            **rule_args)
        self.assertDictEqual(
            expected_rule,
            self._filter_not_relevant_rule_keys(created_rule_template)
        )
        observed_rule_template = (
            self.admin_client.get_default_security_group_rule(
                created_rule_template['id'])
        )['default_security_group_rule']
        self.assertDictEqual(
            expected_rule,
            self._filter_not_relevant_rule_keys(observed_rule_template)
        )

        self.admin_client.delete_default_security_group_rule(
            created_rule_template['id']
        )
        self.assertRaises(
            lib_exc.NotFound,
            self.admin_client.get_default_security_group_rule,
            created_rule_template['id']
        )

    @decorators.idempotent_id('6c5a2f41-5899-47f4-9daf-4f8ddbbd3ad5')
    def test_create_duplicate_default_security_group_rule_different_templates(
            self):
        tcp_port = random.randint(constants.PORT_RANGE_MIN,
                                  constants.PORT_RANGE_MAX)
        rule_args = {
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'port_range_max': tcp_port,
            'port_range_min': tcp_port,
            'used_in_default_sg': True,
            'used_in_non_default_sg': True}
        self.create_default_security_group_rule(**rule_args)

        # Now, even if 'used_in_non_default_sg' will be different error should
        # be returned as 'used_in_default_sg' is the same
        new_rule_args = copy.copy(rule_args)
        new_rule_args['used_in_non_default_sg'] = False
        self.assertRaises(
            lib_exc.Conflict,
            self.admin_client.create_default_security_group_rule,
            **new_rule_args)

        # Same in the opposite way: even if 'used_in_default_sg' will be
        # different error should be returned as 'used_in_non_default_sg'
        # is the same
        new_rule_args = copy.copy(rule_args)
        new_rule_args['used_in_default_sg'] = False
        self.assertRaises(
            lib_exc.Conflict,
            self.admin_client.create_default_security_group_rule,
            **new_rule_args)

    @decorators.idempotent_id('e4696607-1a13-48eb-8912-ee1e742d9471')
    def test_create_same_default_security_group_rule_for_different_templates(
            self):
        tcp_port = random.randint(constants.PORT_RANGE_MIN,
                                  constants.PORT_RANGE_MAX)
        expected_rules = [{
            'remote_group_id': None,
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'remote_ip_prefix': None,
            'remote_address_group_id': None,
            'port_range_max': tcp_port,
            'port_range_min': tcp_port,
            'used_in_default_sg': True,
            'used_in_non_default_sg': False,
            'description': ''
        }, {
            'remote_group_id': None,
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'remote_ip_prefix': None,
            'remote_address_group_id': None,
            'port_range_max': tcp_port,
            'port_range_min': tcp_port,
            'used_in_default_sg': False,
            'used_in_non_default_sg': True,
            'description': ''
        }]

        default_sg_rule_args = {
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'port_range_max': tcp_port,
            'port_range_min': tcp_port,
            'used_in_default_sg': True,
            'used_in_non_default_sg': False}
        self.create_default_security_group_rule(**default_sg_rule_args)

        custom_sg_rule_args = {
            'direction': 'ingress',
            'ethertype': 'IPv4',
            'protocol': 'tcp',
            'port_range_max': tcp_port,
            'port_range_min': tcp_port,
            'used_in_default_sg': False,
            'used_in_non_default_sg': True}
        self.create_default_security_group_rule(**custom_sg_rule_args)

        sg_rules_template = (
            self.admin_client.list_default_security_group_rules()[
                'default_security_group_rules'
            ])
        self._assert_rules_exists(
            expected_rules,
            self._filter_not_relevant_rules_keys(sg_rules_template))

    def _validate_security_group_rules(self, sg, is_default_sg):
        keys_to_check = [
            'remote_group_id', 'direction', 'ethertype', 'protocol',
            'remote_ip_prefix', 'remote_address_group_id', 'port_range_min',
            'port_range_max']

        if is_default_sg:
            sg_rules_template = (
                self.admin_client.list_default_security_group_rules(
                    used_in_default_sg=True)['default_security_group_rules'])
        else:
            sg_rules_template = (
                self.admin_client.list_default_security_group_rules(
                    used_in_non_default_sg=True
                )['default_security_group_rules'])
        # NOTE(slaweq): We need to replace "PARENT" keyword in
        # the "remote_group_id" attribute of every default sg rule template
        # with actual SG ID
        for rule in sg_rules_template:
            if rule['remote_group_id'] == 'PARENT':
                rule['remote_group_id'] = sg['id']

        self._assert_rules_exists(
            self._filter_not_relevant_rules_keys(
                sg_rules_template, keys_to_check),
            self._filter_not_relevant_rules_keys(
                sg['security_group_rules'], keys_to_check))

    @decorators.idempotent_id('29feedb1-6f04-4a1f-a778-2fae2c7b7dc8')
    def test_security_group_rules_created_from_default_sg_rules_template(
            self):
        """Test if default SG and custom new SG have got proper SG rules.

        This test creates new project and checks if its default SG has SG
        rules matching default SG rules for that kind of SG.
        Next it creates new SG for the same project and checks if that SG also
        have proper SG rules based on the default SG rules template.
        """

        project = self.create_project()
        # First check rules for default SG created automatically for each
        # project
        default_sg = self.admin_client.list_security_groups(
            tenant_id=project['id'], name='default')['security_groups'][0]
        self._validate_security_group_rules(default_sg, is_default_sg=True)

        # And now create different SG for same project and check SG rules for
        # such additional SG
        sg = self.create_security_group(project=project)
        self._validate_security_group_rules(sg, is_default_sg=False)