summaryrefslogtreecommitdiff
path: root/openstackclient/tests/unit/network/v2/test_l3_conntrack_helper.py
blob: b3d026a7ef55327d9fe22840d746e86494bc38de (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
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
#   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.
#

from unittest import mock

from osc_lib import exceptions

from openstackclient.network.v2 import l3_conntrack_helper
from openstackclient.tests.unit.network.v2 import fakes as network_fakes
from openstackclient.tests.unit import utils as tests_utils


class TestConntrackHelper(network_fakes.TestNetworkV2):

    def setUp(self):
        super(TestConntrackHelper, self).setUp()
        # Get a shortcut to the network client
        self.network = self.app.client_manager.network
        self.router = network_fakes.FakeRouter.create_one_router()
        self.network.find_router = mock.Mock(return_value=self.router)


class TestCreateL3ConntrackHelper(TestConntrackHelper):

    def setUp(self):
        super(TestCreateL3ConntrackHelper, self).setUp()
        attrs = {'router_id': self.router.id}
        self.ct_helper = (
            network_fakes.FakeL3ConntrackHelper.create_one_l3_conntrack_helper(
                attrs))
        self.columns = (
            'helper',
            'id',
            'port',
            'protocol',
            'router_id'
        )

        self.data = (
            self.ct_helper.helper,
            self.ct_helper.id,
            self.ct_helper.port,
            self.ct_helper.protocol,
            self.ct_helper.router_id
        )
        self.network.create_conntrack_helper = mock.Mock(
            return_value=self.ct_helper)

        # Get the command object to test
        self.cmd = l3_conntrack_helper.CreateConntrackHelper(self.app,
                                                             self.namespace)

    def test_create_no_options(self):
        arglist = []
        verifylist = []

        # Missing required args should bail here
        self.assertRaises(tests_utils.ParserException, self.check_parser,
                          self.cmd, arglist, verifylist)

    def test_create_default_options(self):
        arglist = [
            '--helper', 'tftp',
            '--protocol', 'udp',
            '--port', '69',
            self.router.id,
        ]

        verifylist = [
            ('helper', 'tftp'),
            ('protocol', 'udp'),
            ('port', 69),
        ]

        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        columns, data = (self.cmd.take_action(parsed_args))

        self.network.create_conntrack_helper.assert_called_once_with(
            self.router.id,
            **{'helper': 'tftp', 'protocol': 'udp',
               'port': 69}
        )
        self.assertEqual(self.columns, columns)
        self.assertEqual(self.data, data)

    def test_create_wrong_options(self):
        arglist = [
            '--protocol', 'udp',
            '--port', '69',
            self.router.id,
        ]

        self.assertRaises(
            tests_utils.ParserException,
            self.check_parser,
            self.cmd, arglist, None)


class TestDeleteL3ConntrackHelper(TestConntrackHelper):

    def setUp(self):
        super(TestDeleteL3ConntrackHelper, self).setUp()
        attrs = {'router_id': self.router.id}
        self.ct_helper = (
            network_fakes.FakeL3ConntrackHelper.create_one_l3_conntrack_helper(
                attrs))
        self.network.delete_conntrack_helper = mock.Mock(
            return_value=None)

        # Get the command object to test
        self.cmd = l3_conntrack_helper.DeleteConntrackHelper(self.app,
                                                             self.namespace)

    def test_delete(self):
        arglist = [
            self.ct_helper.router_id,
            self.ct_helper.id
        ]
        verifylist = [
            ('conntrack_helper_id', [self.ct_helper.id]),
            ('router', self.ct_helper.router_id),
        ]
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        result = self.cmd.take_action(parsed_args)
        self.network.delete_conntrack_helper.assert_called_once_with(
            self.ct_helper.id, self.router.id,
            ignore_missing=False)
        self.assertIsNone(result)

    def test_delete_error(self):
        arglist = [
            self.router.id,
            self.ct_helper.id
        ]
        verifylist = [
            ('conntrack_helper_id', [self.ct_helper.id]),
            ('router', self.router.id),
        ]
        self.network.delete_conntrack_helper.side_effect = Exception(
            'Error message')
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        self.assertRaises(
            exceptions.CommandError,
            self.cmd.take_action, parsed_args)


class TestListL3ConntrackHelper(TestConntrackHelper):

    def setUp(self):
        super(TestListL3ConntrackHelper, self).setUp()
        attrs = {'router_id': self.router.id}
        ct_helpers = (
            network_fakes.FakeL3ConntrackHelper.create_l3_conntrack_helpers(
                attrs, count=3))
        self.columns = (
            'ID',
            'Router ID',
            'Helper',
            'Protocol',
            'Port',
        )
        self.data = []
        for ct_helper in ct_helpers:
            self.data.append((
                ct_helper.id,
                ct_helper.router_id,
                ct_helper.helper,
                ct_helper.protocol,
                ct_helper.port,
            ))
        self.network.conntrack_helpers = mock.Mock(
            return_value=ct_helpers)

        # Get the command object to test
        self.cmd = l3_conntrack_helper.ListConntrackHelper(self.app,
                                                           self.namespace)

    def test_conntrack_helpers_list(self):
        arglist = [
            self.router.id
        ]
        verifylist = [
            ('router', self.router.id),
        ]

        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        columns, data = self.cmd.take_action(parsed_args)

        self.network.conntrack_helpers.assert_called_once_with(
            self.router.id)
        self.assertEqual(self.columns, columns)
        list_data = list(data)
        self.assertEqual(len(self.data), len(list_data))
        for index in range(len(list_data)):
            self.assertEqual(self.data[index], list_data[index])


class TestSetL3ConntrackHelper(TestConntrackHelper):

    def setUp(self):
        super(TestSetL3ConntrackHelper, self).setUp()
        attrs = {'router_id': self.router.id}
        self.ct_helper = (
            network_fakes.FakeL3ConntrackHelper.create_one_l3_conntrack_helper(
                attrs))
        self.network.update_conntrack_helper = mock.Mock(return_value=None)

        # Get the command object to test
        self.cmd = l3_conntrack_helper.SetConntrackHelper(self.app,
                                                          self.namespace)

    def test_set_nothing(self):
        arglist = [
            self.router.id,
            self.ct_helper.id,
        ]
        verifylist = [
            ('router', self.router.id),
            ('conntrack_helper_id', self.ct_helper.id),
        ]

        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        result = (self.cmd.take_action(parsed_args))

        self.network.update_conntrack_helper.assert_called_once_with(
            self.ct_helper.id, self.router.id
        )
        self.assertIsNone(result)

    def test_set_port(self):
        arglist = [
            self.router.id,
            self.ct_helper.id,
            '--port', '124',
        ]
        verifylist = [
            ('router', self.router.id),
            ('conntrack_helper_id', self.ct_helper.id),
            ('port', 124),
        ]

        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        result = (self.cmd.take_action(parsed_args))

        self.network.update_conntrack_helper.assert_called_once_with(
            self.ct_helper.id, self.router.id, port=124
        )
        self.assertIsNone(result)


class TestShowL3ConntrackHelper(TestConntrackHelper):

    def setUp(self):
        super(TestShowL3ConntrackHelper, self).setUp()
        attrs = {'router_id': self.router.id}
        self.ct_helper = (
            network_fakes.FakeL3ConntrackHelper.create_one_l3_conntrack_helper(
                attrs))
        self.columns = (
            'helper',
            'id',
            'port',
            'protocol',
            'router_id'
        )

        self.data = (
            self.ct_helper.helper,
            self.ct_helper.id,
            self.ct_helper.port,
            self.ct_helper.protocol,
            self.ct_helper.router_id
        )
        self.network.get_conntrack_helper = mock.Mock(
            return_value=self.ct_helper)

        # Get the command object to test
        self.cmd = l3_conntrack_helper.ShowConntrackHelper(self.app,
                                                           self.namespace)

    def test_show_no_options(self):
        arglist = []
        verifylist = []

        # Missing required args should bail here
        self.assertRaises(tests_utils.ParserException, self.check_parser,
                          self.cmd, arglist, verifylist)

    def test_show_default_options(self):
        arglist = [
            self.router.id,
            self.ct_helper.id,
        ]
        verifylist = [
            ('router', self.router.id),
            ('conntrack_helper_id', self.ct_helper.id),
        ]

        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        columns, data = (self.cmd.take_action(parsed_args))

        self.network.get_conntrack_helper.assert_called_once_with(
            self.ct_helper.id, self.router.id
        )
        self.assertEqual(self.columns, columns)
        self.assertEqual(self.data, data)