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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import unittest
import pytest
from azure.core.exceptions import DecodeError, HttpResponseError, ResourceExistsError
from azure.storage.queue import (
BinaryBase64DecodePolicy,
BinaryBase64EncodePolicy,
QueueClient,
QueueServiceClient,
TextBase64DecodePolicy,
TextBase64EncodePolicy,
)
from azure.storage.queue._message_encoding import NoDecodePolicy, NoEncodePolicy
from devtools_testutils import recorded_by_proxy
from devtools_testutils.storage import StorageRecordedTestCase
from settings.testcase import QueuePreparer
# ------------------------------------------------------------------------------
TEST_QUEUE_PREFIX = "mytestqueue"
# ------------------------------------------------------------------------------
class TestStorageQueueEncoding(StorageRecordedTestCase):
# --Helpers-----------------------------------------------------------------
def _get_queue_reference(self, qsc, prefix=TEST_QUEUE_PREFIX):
queue_name = self.get_resource_name(prefix)
queue = qsc.get_queue_client(queue_name)
return queue
def _create_queue(self, qsc, prefix=TEST_QUEUE_PREFIX):
queue = self._get_queue_reference(qsc, prefix)
try:
created = queue.create_queue()
except ResourceExistsError:
pass
return queue
def _validate_encoding(self, queue, message):
# Arrange
try:
created = queue.create_queue()
except ResourceExistsError:
pass
# Action.
queue.send_message(message)
# Asserts
dequeued = next(queue.receive_messages())
assert message == dequeued.content
# --------------------------------------------------------------------------
@QueuePreparer()
@recorded_by_proxy
def test_message_text_xml(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange.
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
message = "<message1>"
queue = qsc.get_queue_client(self.get_resource_name(TEST_QUEUE_PREFIX))
# Asserts
assert isinstance(queue._message_encode_policy, NoEncodePolicy)
assert isinstance(queue._message_decode_policy, NoDecodePolicy)
self._validate_encoding(queue, message)
@QueuePreparer()
@recorded_by_proxy
def test_message_text_xml_whitespace(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange.
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
message = " mess\t age1\n"
queue = qsc.get_queue_client(self.get_resource_name(TEST_QUEUE_PREFIX))
# Asserts
self._validate_encoding(queue, message)
@QueuePreparer()
@recorded_by_proxy
def test_message_text_xml_invalid_chars(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Action.
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
queue = self._get_queue_reference(qsc)
message = "\u0001"
# Asserts
with pytest.raises(HttpResponseError):
queue.send_message(message)
@QueuePreparer()
@recorded_by_proxy
def test_message_text_base64(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange.
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
queue = QueueClient(
account_url=self.account_url(storage_account_name, "queue"),
queue_name=self.get_resource_name(TEST_QUEUE_PREFIX),
credential=storage_account_key,
message_encode_policy=TextBase64EncodePolicy(),
message_decode_policy=TextBase64DecodePolicy(),
)
message = "\u0001"
# Asserts
self._validate_encoding(queue, message)
@QueuePreparer()
@recorded_by_proxy
def test_message_bytes_base64(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange.
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
queue = QueueClient(
account_url=self.account_url(storage_account_name, "queue"),
queue_name=self.get_resource_name(TEST_QUEUE_PREFIX),
credential=storage_account_key,
message_encode_policy=BinaryBase64EncodePolicy(),
message_decode_policy=BinaryBase64DecodePolicy(),
)
message = b"xyz"
# Asserts
self._validate_encoding(queue, message)
@QueuePreparer()
@recorded_by_proxy
def test_message_bytes_fails(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
queue = qsc.get_queue_client(self.get_resource_name("failqueue"))
queue.create_queue()
# Action.
with pytest.raises(TypeError) as e:
message = b"xyz"
queue.send_message(message)
# Asserts
assert str(
e.exception.startswith(
"Message content must not be bytes. " "Use the BinaryBase64EncodePolicy to send bytes."
)
)
@QueuePreparer()
def test_message_text_fails(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
queue = QueueClient(
account_url=self.account_url(storage_account_name, "queue"),
queue_name=self.get_resource_name(TEST_QUEUE_PREFIX),
credential=storage_account_key,
message_encode_policy=BinaryBase64EncodePolicy(),
message_decode_policy=BinaryBase64DecodePolicy(),
)
# Action.
with pytest.raises(TypeError) as e:
message = "xyz"
queue.send_message(message)
# Asserts
assert str(e.value).startswith("Message content must be bytes")
@QueuePreparer()
@recorded_by_proxy
def test_message_base64_decode_fails(self, **kwargs):
storage_account_name = kwargs.pop("storage_account_name")
storage_account_key = kwargs.pop("storage_account_key")
# Arrange
qsc = QueueServiceClient(self.account_url(storage_account_name, "queue"), storage_account_key)
queue = QueueClient(
account_url=self.account_url(storage_account_name, "queue"),
queue_name=self.get_resource_name(TEST_QUEUE_PREFIX),
credential=storage_account_key,
message_encode_policy=None,
message_decode_policy=BinaryBase64DecodePolicy(),
)
try:
queue.create_queue()
except ResourceExistsError:
pass
message = "xyz"
queue.send_message(message)
# Action.
with pytest.raises(DecodeError) as e:
queue.peek_messages()
# Asserts
assert -1 != str(e.value).find("Message content is not valid base 64")
def test_message_no_encoding(self):
# Arrange
queue = QueueClient(
account_url="https://account.queue.core.windows.net",
queue_name="queue",
credential="account_key",
message_encode_policy=None,
message_decode_policy=None,
)
# Asserts
assert isinstance(queue._message_encode_policy, NoEncodePolicy)
assert isinstance(queue._message_decode_policy, NoDecodePolicy)
# ------------------------------------------------------------------------------
if __name__ == "__main__":
unittest.main()
|
