summaryrefslogtreecommitdiff
path: root/openstack_dashboard/test/unit/api/test_swift.py
blob: 5645db3fadb98ed94d5b7fa9d38f3c87eeaa8336 (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
# Copyright 2012 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# All Rights Reserved.
#
# Copyright 2012 Nebula, Inc.
#
#    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 horizon import exceptions

from openstack_dashboard import api
from openstack_dashboard.test import helpers as test


@mock.patch('swiftclient.client.Connection')
class SwiftApiTests(test.APIMockTestCase):
    def test_swift_get_containers(self, mock_swiftclient):
        containers = self.containers.list()
        cont_data = [c._apidict for c in containers]
        swift_api = mock_swiftclient.return_value
        swift_api.get_account.return_value = [{}, cont_data]

        (conts, more) = api.swift.swift_get_containers(self.request)

        self.assertEqual(len(containers), len(conts))
        self.assertFalse(more)
        swift_api.get_account.assert_called_once_with(
            limit=1001, marker=None, prefix=None, full_listing=True)

    def test_swift_get_container_with_data(self, mock_swiftclient):
        container = self.containers.first()
        objects = self.objects.list()
        swift_api = mock_swiftclient.return_value
        swift_api.get_object.return_value = (container, objects)

        cont = api.swift.swift_get_container(self.request, container.name)

        self.assertEqual(container.name, cont.name)
        self.assertEqual(len(objects), len(cont.data))
        swift_api.get_object.assert_called_once_with(container.name, "")

    def test_swift_get_container_without_data(self, mock_swiftclient):
        container = self.containers.first()
        swift_api = mock_swiftclient.return_value
        swift_api.head_container.return_value = container

        cont = api.swift.swift_get_container(self.request,
                                             container.name,
                                             with_data=False)

        self.assertEqual(cont.name, container.name)
        self.assertIsNone(cont.data)
        swift_api.head_container.assert_called_once_with(container.name)

    def test_swift_create_duplicate_container(self, mock_swiftclient):
        metadata = {'is_public': False}
        container = self.containers.first()
        headers = api.swift._metadata_to_header(metadata=(metadata))
        swift_api = mock_swiftclient.return_value
        # Check for existence, then create
        swift_api.head_container.side_effect = self.exceptions.swift
        swift_api.put_container.return_value = container

        api.swift.swift_create_container(self.request,
                                         container.name,
                                         metadata=(metadata))

        swift_api.head_container.assert_called_once_with(container.name)
        swift_api.put_container.assert_called_once_with(container.name,
                                                        headers=headers)

    def test_swift_create_container(self, mock_swiftclient):
        metadata = {'is_public': True}
        container = self.containers.first()
        swift_api = mock_swiftclient.return_value
        swift_api.head_container.return_value = container

        with self.assertRaises(exceptions.AlreadyExists):
            api.swift.swift_create_container(self.request,
                                             container.name,
                                             metadata=(metadata))

        swift_api.head_container.assert_called_once_with(container.name)

    def test_swift_create_container_with_storage_policy(self, mock_swiftclient):
        metadata = {'is_public': True, 'storage_policy': 'nz-o1-mr-r3'}
        container = self.containers.first()
        swift_api = mock_swiftclient.return_value
        swift_api.head_container.return_value = container

        headers = api.swift._metadata_to_header(metadata=(metadata))
        self.assertEqual(headers["x-storage-policy"], 'nz-o1-mr-r3')

        with self.assertRaises(exceptions.AlreadyExists):
            api.swift.swift_create_container(self.request,
                                             container.name,
                                             metadata=(metadata))

        swift_api.head_container.assert_called_once_with(container.name)

    def test_metadata_to_headers(self, mock_swiftclient):
        metadata = {'is_public': True, 'storage_policy': 'nz-o1-mr-r3'}
        headers = api.swift._metadata_to_header(metadata=(metadata))
        self.assertEqual(headers["x-storage-policy"], 'nz-o1-mr-r3')
        self.assertEqual(headers["x-container-read"], '.r:*,.rlistings')

    def test_metadata_to_headers_without_metadata(self, mock_swiftclient):
        metadata = {}
        headers = api.swift._metadata_to_header(metadata=(metadata))
        self.assertNotIn("x-storage-policy", headers)
        self.assertNotIn("x-container-read", headers)

    def test_swift_update_container(self, mock_swiftclient):
        metadata = {'is_public': True}
        container = self.containers.first()
        swift_api = mock_swiftclient.return_value
        headers = api.swift._metadata_to_header(metadata=(metadata))
        swift_api.post_container.return_value = container

        api.swift.swift_update_container(self.request,
                                         container.name,
                                         metadata=(metadata))

        swift_api.post_container.assert_called_once_with(container.name,
                                                         headers=headers)

    def test_swift_get_objects(self, mock_swiftclient):
        container = self.containers.first()
        objects = self.objects.list()

        swift_api = mock_swiftclient.return_value
        swift_api.get_container.return_value = [{}, objects]

        (objs, more) = api.swift.swift_get_objects(self.request,
                                                   container.name)

        self.assertEqual(len(objects), len(objs))
        self.assertFalse(more)
        swift_api.get_container.assert_called_once_with(
            container.name,
            limit=1001,
            marker=None,
            prefix=None,
            delimiter='/',
            full_listing=True)

    def test_swift_get_object_with_data_non_chunked(self, mock_swiftclient):
        container = self.containers.first()
        object = self.objects.first()

        swift_api = mock_swiftclient.return_value
        swift_api.get_object.return_value = [object, object.data]

        obj = api.swift.swift_get_object(self.request, container.name,
                                         object.name, resp_chunk_size=None)

        self.assertEqual(object.name, obj.name)
        swift_api.get_object.assert_called_once_with(
            container.name, object.name, resp_chunk_size=None)

    def test_swift_get_object_with_data_chunked(self, mock_swiftclient):
        container = self.containers.first()
        object = self.objects.first()

        swift_api = mock_swiftclient.return_value
        swift_api.get_object.return_value = [object, object.data]

        obj = api.swift.swift_get_object(
            self.request, container.name, object.name)

        self.assertEqual(object.name, obj.name)
        swift_api.get_object.assert_called_once_with(
            container.name, object.name, resp_chunk_size=api.swift.CHUNK_SIZE)

    def test_swift_get_object_without_data(self, mock_swiftclient):
        container = self.containers.first()
        object = self.objects.first()

        swift_api = mock_swiftclient.return_value
        swift_api.head_object.return_value = object

        obj = api.swift.swift_get_object(self.request,
                                         container.name,
                                         object.name,
                                         with_data=False)

        self.assertEqual(object.name, obj.name)
        self.assertIsNone(obj.data)
        swift_api.head_object.assert_called_once_with(container.name,
                                                      object.name)

    def test_swift_create_pseudo_folder(self, mock_swiftclient):
        container = self.containers.first()
        folder = self.folder.first()
        swift_api = mock_swiftclient.return_value
        exc = self.exceptions.swift
        swift_api.head_object.side_effect = exc
        swift_api.put_object.return_value = folder

        api.swift.swift_create_pseudo_folder(self.request,
                                             container.name,
                                             folder.name)

        swift_api.head_object.assert_called_once_with(container.name,
                                                      folder.name)
        swift_api.put_object.assert_called_once_with(container.name,
                                                     folder.name,
                                                     None,
                                                     headers={})

    def test_swift_create_duplicate_folder(self, mock_swiftclient):
        container = self.containers.first()
        folder = self.folder.first()
        swift_api = mock_swiftclient.return_value
        swift_api.head_object.return_value = folder

        with self.assertRaises(exceptions.AlreadyExists):
            api.swift.swift_create_pseudo_folder(self.request,
                                                 container.name,
                                                 folder.name)

        swift_api.head_object.assert_called_once_with(container.name,
                                                      folder.name)

    def test_swift_upload_object(self, mock_swiftclient):
        container = self.containers.first()
        obj = self.objects.first()
        fake_name = 'fake_object.jpg'

        class FakeFile(object):
            def __init__(self):
                self.name = fake_name
                self.data = obj.data
                self.size = len(obj.data)

        headers = {'X-Object-Meta-Orig-Filename': fake_name}

        swift_api = mock_swiftclient.return_value
        test_file = FakeFile()
        swift_api.put_object.return_value = None

        api.swift.swift_upload_object(self.request,
                                      container.name,
                                      obj.name,
                                      test_file)

        swift_api.put_object.assert_called_once_with(
            container.name,
            obj.name,
            test.IsA(FakeFile),
            content_length=test_file.size,
            headers=headers)

    def test_swift_upload_object_without_file(self, mock_swiftclient):
        container = self.containers.first()
        obj = self.objects.first()

        swift_api = mock_swiftclient.return_value
        swift_api.put_object.return_value = None

        response = api.swift.swift_upload_object(self.request,
                                                 container.name,
                                                 obj.name,
                                                 None)

        self.assertEqual(0, response['bytes'])
        swift_api.put_object.assert_called_once_with(
            container.name,
            obj.name,
            None,
            content_length=0,
            headers={})

    def test_swift_object_exists(self, mock_swiftclient):
        container = self.containers.first()
        obj = self.objects.first()

        swift_api = mock_swiftclient.return_value
        swift_api.head_object.side_effect = [container, self.exceptions.swift]

        args = self.request, container.name, obj.name

        self.assertTrue(api.swift.swift_object_exists(*args))
        # Again, for a "non-existent" object
        self.assertFalse(api.swift.swift_object_exists(*args))

        self.assertEqual(2, swift_api.head_object.call_count)
        swift_api.head_object.assert_has_calls([
            mock.call(container.name, obj.name),
            mock.call(container.name, obj.name),
        ])