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
|
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# --------------------------------------------------------------------------
import time
try:
from unittest import mock
except ImportError:
import mock
import pytest
from azure.core import PipelineClient
from azure.core.exceptions import ServiceResponseError
from azure.core.polling import *
from azure.core.polling.base_polling import LROBasePolling, LocationPolling
# from msrest.serialization import Model
@pytest.fixture
def client():
# The poller itself don't use it, so we don't need something functional
return PipelineClient("https://baseurl")
def test_abc_polling():
abc_polling = PollingMethod()
with pytest.raises(NotImplementedError):
abc_polling.initialize(None, None, None)
with pytest.raises(NotImplementedError):
abc_polling.run()
with pytest.raises(NotImplementedError):
abc_polling.status()
with pytest.raises(NotImplementedError):
abc_polling.finished()
with pytest.raises(NotImplementedError):
abc_polling.resource()
with pytest.raises(TypeError):
abc_polling.get_continuation_token()
with pytest.raises(TypeError):
abc_polling.from_continuation_token("token")
def test_no_polling(client):
no_polling = NoPolling()
initial_response = "initial response"
def deserialization_cb(response):
assert response == initial_response
return "Treated: " + response
no_polling.initialize(client, initial_response, deserialization_cb)
no_polling.run() # Should no raise and do nothing
assert no_polling.status() == "succeeded"
assert no_polling.finished()
assert no_polling.resource() == "Treated: " + initial_response
continuation_token = no_polling.get_continuation_token()
assert isinstance(continuation_token, str)
no_polling_revived_args = NoPolling.from_continuation_token(
continuation_token, deserialization_callback=deserialization_cb, client=client
)
no_polling_revived = NoPolling()
no_polling_revived.initialize(*no_polling_revived_args)
assert no_polling_revived.status() == "succeeded"
assert no_polling_revived.finished()
assert no_polling_revived.resource() == "Treated: " + initial_response
def test_polling_with_path_format_arguments(client):
method = LROBasePolling(timeout=0, path_format_arguments={"host": "host:3000", "accountName": "local"})
client._base_url = "http://{accountName}{host}"
method._operation = LocationPolling()
method._operation._location_url = "/results/1"
method._client = client
assert "http://localhost:3000/results/1" == method._client.format_url(
method._operation.get_polling_url(), **method._path_format_arguments
)
class PollingTwoSteps(PollingMethod):
"""An empty poller that returns the deserialized initial response."""
def __init__(self, sleep=0):
self._initial_response = None
self._deserialization_callback = None
self._sleep = sleep
def initialize(self, _, initial_response, deserialization_callback):
self._initial_response = initial_response
self._deserialization_callback = deserialization_callback
self._finished = False
def run(self):
"""Empty run, no polling."""
self._finished = True
time.sleep(self._sleep) # Give me time to add callbacks!
def status(self):
"""Return the current status as a string.
:rtype: str
"""
return "succeeded" if self._finished else "running"
def finished(self):
"""Is this polling finished?
:rtype: bool
"""
return self._finished
def resource(self):
return self._deserialization_callback(self._initial_response)
def get_continuation_token(self):
return self._initial_response
@classmethod
def from_continuation_token(cls, continuation_token, **kwargs):
# type(str, Any) -> Tuple
initial_response = continuation_token
deserialization_callback = kwargs["deserialization_callback"]
return None, initial_response, deserialization_callback
def test_poller(client):
# Same the poller itself doesn't care about the initial_response, and there is no type constraint here
initial_response = "Initial response"
# Same for deserialization_callback, just pass to the polling_method
def deserialization_callback(response):
assert response == initial_response
return "Treated: " + response
method = NoPolling()
poller = LROPoller(client, initial_response, deserialization_callback, method)
done_cb = mock.MagicMock()
poller.add_done_callback(done_cb)
result = poller.result()
assert poller.done()
assert result == "Treated: " + initial_response
assert poller.status() == "succeeded"
assert poller.polling_method() is method
done_cb.assert_called_once_with(method)
# # Test with a basic Model
# poller = LROPoller(client, initial_response, Model, method)
# assert poller._polling_method._deserialization_callback == Model.deserialize
# Test poller that method do a run
method = PollingTwoSteps(sleep=1)
poller = LROPoller(client, initial_response, deserialization_callback, method)
done_cb = mock.MagicMock()
done_cb2 = mock.MagicMock()
poller.add_done_callback(done_cb)
poller.remove_done_callback(done_cb2)
result = poller.result()
assert result == "Treated: " + initial_response
assert poller.status() == "succeeded"
done_cb.assert_called_once_with(method)
done_cb2.assert_not_called()
with pytest.raises(ValueError) as excinfo:
poller.remove_done_callback(done_cb)
assert "Process is complete" in str(excinfo.value)
# Test continuation token
cont_token = poller.continuation_token()
method = PollingTwoSteps(sleep=1)
new_poller = LROPoller.from_continuation_token(
continuation_token=cont_token,
client=client,
initial_response=initial_response,
deserialization_callback=deserialization_callback,
polling_method=method,
)
result = new_poller.result()
assert result == "Treated: " + initial_response
assert new_poller.status() == "succeeded"
def test_broken_poller(client):
class NoPollingError(PollingTwoSteps):
def run(self):
raise ValueError("Something bad happened")
initial_response = "Initial response"
def deserialization_callback(response):
return "Treated: " + response
method = NoPollingError()
poller = LROPoller(client, initial_response, deserialization_callback, method)
with pytest.raises(ValueError) as excinfo:
poller.result()
assert "Something bad happened" in str(excinfo.value)
def test_poller_error_continuation(client):
class NoPollingError(PollingTwoSteps):
def run(self):
raise ServiceResponseError("Something bad happened")
initial_response = "Initial response"
def deserialization_callback(response):
return "Treated: " + response
method = NoPollingError()
poller = LROPoller(client, initial_response, deserialization_callback, method)
with pytest.raises(ServiceResponseError) as excinfo:
poller.result()
assert "Something bad happened" in str(excinfo.value)
assert excinfo.value.continuation_token == "Initial response"
|