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
|
# coding: utf-8
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
from datetime import datetime
import pytest
from devtools_testutils import recorded_by_proxy
from azure.core.exceptions import (
HttpResponseError,
)
from _router_test_case import RouterRecordedTestCase
from _decorators import RouterPreparers
from azure.communication.jobrouter import (
JobRouterClient,
JobRouterAdministrationClient,
)
from azure.communication.jobrouter.models import (
LongestIdleMode,
RouterChannel,
RouterJobStatus,
RouterWorker,
RouterJobOffer,
AcceptJobOfferResult,
UnassignJobResult,
RouterJob,
RouterJobAssignment,
RouterWorkerState,
DistributionPolicy,
RouterQueue,
DeclineJobOfferOptions,
CompleteJobOptions,
CloseJobOptions,
)
channel_id = "fakeChannel1"
# The test class name needs to start with "Test" to get collected by pytest
class TestAssignmentScenario(RouterRecordedTestCase):
def clean_up(self, **kwargs):
# delete in live mode
if not self.is_playback():
router_admin_client: JobRouterAdministrationClient = self.create_admin_client()
router_client: JobRouterClient = self.create_client()
if self._testMethodName in self.job_ids and any(self.job_ids[self._testMethodName]):
for _id in set(self.job_ids[self._testMethodName]):
self.clean_up_job(job_id=_id, suppress_errors=True)
if self._testMethodName in self.worker_ids and any(self.worker_ids[self._testMethodName]):
for _id in set(self.worker_ids[self._testMethodName]):
# delete worker
router_client.delete_worker(_id)
if self._testMethodName in self.classification_policy_ids and any(
self.classification_policy_ids[self._testMethodName]
):
for policy_id in set(self.classification_policy_ids[self._testMethodName]):
router_admin_client.delete_classification_policy(policy_id)
if self._testMethodName in self.queue_ids and any(self.queue_ids[self._testMethodName]):
for policy_id in set(self.queue_ids[self._testMethodName]):
router_admin_client.delete_queue(policy_id)
if self._testMethodName in self.distribution_policy_ids and any(
self.distribution_policy_ids[self._testMethodName]
):
for policy_id in set(self.distribution_policy_ids[self._testMethodName]):
router_admin_client.delete_distribution_policy(policy_id)
def get_distribution_policy_id(self, **kwargs):
return "_" + self._testMethodName + "_tst_dp"
def setup_distribution_policy(self, **kwargs):
client: JobRouterAdministrationClient = self.create_admin_client()
distribution_policy_id = self.get_distribution_policy_id()
policy: DistributionPolicy = DistributionPolicy(
offer_expires_after_seconds=10.0 * 60,
mode=LongestIdleMode(min_concurrent_offers=1, max_concurrent_offers=1),
name="test",
)
distribution_policy = client.upsert_distribution_policy(distribution_policy_id, policy)
# add for cleanup later
if self._testMethodName in self.distribution_policy_ids:
self.distribution_policy_ids[self._testMethodName] = self.distribution_policy_ids[
self._testMethodName
].append(distribution_policy_id)
else:
self.distribution_policy_ids[self._testMethodName] = [distribution_policy_id]
def get_job_queue_id(self, **kwargs):
return "_" + self._testMethodName + "_tst_q"
def setup_job_queue(self, **kwargs):
client: JobRouterAdministrationClient = self.create_admin_client()
job_queue_id = self.get_job_queue_id()
job_queue: RouterQueue = RouterQueue(distribution_policy_id=self.get_distribution_policy_id(), name="test")
job_queue = client.upsert_queue(job_queue_id, job_queue)
# add for cleanup later
if self._testMethodName in self.queue_ids:
self.queue_ids[self._testMethodName] = self.queue_ids[self._testMethodName].append(job_queue_id)
else:
self.queue_ids[self._testMethodName] = [job_queue_id]
def get_router_worker_id(self, **kwargs):
return "_" + self._testMethodName + "_tst_w"
def setup_router_worker(self, **kwargs):
w_identifier = self.get_router_worker_id()
router_client: JobRouterClient = self.create_client()
worker_queues = [self.get_job_queue_id()]
worker_channels = [RouterChannel(channel_id=channel_id, capacity_cost_per_job=1)]
worker: RouterWorker = RouterWorker(
capacity=1,
queues=worker_queues,
channels=worker_channels,
available_for_offers=True,
)
router_worker = router_client.upsert_worker(w_identifier, worker)
# add for cleanup
self.worker_ids[self._testMethodName] = [w_identifier]
def validate_job_is_queued(self, identifier, **kwargs):
router_client: JobRouterClient = self.create_client()
router_job = router_client.get_job(identifier)
assert router_job.status == RouterJobStatus.QUEUED
def validate_worker_has_offer(
self,
worker_id, # type: str
job_id, # type: str
**kwargs, # type: Any
):
router_client: JobRouterClient = self.create_client()
router_worker: RouterWorker = router_client.get_worker(worker_id)
offer_for_jobs = [job_offer for job_offer in router_worker.offers if job_offer.job_id == job_id]
assert any(offer_for_jobs)
def validate_worker_deregistration( # cSpell:disable-line
self,
worker_id, # type: str
**kwargs, # type: Any
):
router_client: JobRouterClient = self.create_client()
router_worker: RouterWorker = router_client.get_worker(worker_id)
assert router_worker.state == RouterWorkerState.INACTIVE
@RouterPreparers.router_test_decorator
@recorded_by_proxy
@RouterPreparers.before_test_execute("setup_distribution_policy")
@RouterPreparers.before_test_execute("setup_job_queue")
@RouterPreparers.before_test_execute("setup_router_worker")
@RouterPreparers.after_test_execute("clean_up")
def test_assignment_scenario(self, **kwargs):
router_client: JobRouterClient = self.create_client()
# create job
job_identifier = f"assignment_scenario_job_id"
router_job: RouterJob = RouterJob(
channel_id=channel_id,
queue_id=self.get_job_queue_id(),
priority=1,
)
router_job: RouterJob = router_client.upsert_job(job_identifier, router_job)
# add for cleanup
self.job_ids[self._testMethodName] = [job_identifier]
assert router_job is not None
self._poll_until_no_exception(
self.validate_worker_has_offer, AssertionError, self.get_router_worker_id(), job_identifier
)
router_worker = router_client.get_worker(self.get_router_worker_id())
job_offers = [job_offer for job_offer in router_worker.offers if job_offer.job_id == job_identifier]
assert len(job_offers) == 1
job_offer: RouterJobOffer = job_offers[0]
assert job_offer.capacity_cost == 1
assert job_offer.offered_at is not None
assert job_offer.expires_at is not None
# accept job offer
offer_id = job_offer.offer_id
accept_job_offer_result: AcceptJobOfferResult = router_client.accept_job_offer(
worker_id=self.get_router_worker_id(), offer_id=offer_id
)
assert accept_job_offer_result.job_id == job_identifier
assert accept_job_offer_result.worker_id == self.get_router_worker_id()
assignment_id = accept_job_offer_result.assignment_id
with pytest.raises(HttpResponseError) as sre:
router_client.decline_job_offer(
worker_id=self.get_router_worker_id(),
offer_id=offer_id,
options=DeclineJobOfferOptions(retry_offer_at=datetime.min),
)
assert sre is not None
# unassign job
unassign_job_result: UnassignJobResult = router_client.unassign_job(router_job.id, assignment_id)
# accept unassigned job
self._poll_until_no_exception(
self.validate_worker_has_offer, AssertionError, self.get_router_worker_id(), job_identifier
)
router_worker = router_client.get_worker(self.get_router_worker_id())
job_offers = [job_offer for job_offer in router_worker.offers if job_offer.job_id == job_identifier]
assert len(job_offers) == 1
job_offer: RouterJobOffer = job_offers[0]
assert job_offer.capacity_cost == 1
assert job_offer.offered_at is not None
assert job_offer.expires_at is not None
# accept job offer
offer_id = job_offer.offer_id
accept_job_offer_result: AcceptJobOfferResult = router_client.accept_job_offer(
worker_id=self.get_router_worker_id(), offer_id=offer_id
)
assert accept_job_offer_result.job_id == job_identifier
assert accept_job_offer_result.worker_id == self.get_router_worker_id()
assignment_id = accept_job_offer_result.assignment_id
# complete job
router_client.complete_job(job_identifier, assignment_id)
# close job
router_client.close_job(job_identifier, assignment_id)
# validate post closure job details
queried_job: RouterJob = router_client.get_job(job_identifier)
job_assignment: RouterJobAssignment = queried_job.assignments[assignment_id]
assert job_assignment.assigned_at is not None
assert job_assignment.worker_id == self.get_router_worker_id()
assert job_assignment.completed_at is not None
assert job_assignment.closed_at is not None
|
