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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
from openleadr import OpenADRClient, OpenADRServer, enable_default_logging, objects, utils
import pytest
import asyncio
import datetime
from functools import partial
enable_default_logging()
def on_create_party_registration(registration_info):
print("Registered party")
return 'ven123', 'reg123'
async def on_event(event):
return 'optIn'
async def on_event_opt_in(event, future=None):
if future and future.done() is False:
future.set_result(event)
return 'optIn'
async def on_update_event(event, futures):
for future in futures:
if future.done() is False:
future.set_result(event)
break
return 'optIn'
async def on_event_opt_out(event, futures):
for future in futures:
if future.done() is False:
future.set_result(event)
break
return 'optOut'
async def event_callback(ven_id, event_id, opt_type, future):
if future.done() is False:
future.set_result(opt_type)
@pytest.mark.asyncio
async def test_internal_message_queue():
loop = asyncio.get_event_loop()
client = OpenADRClient(ven_name='myven',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
client.add_handler('on_event', on_event)
server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=datetime.timedelta(seconds=1))
server.add_handler('on_create_party_registration', on_create_party_registration)
event_callback_future = loop.create_future()
server.add_event(ven_id='ven123',
signal_name='simple',
signal_type='level',
intervals=[{'dtstart': datetime.datetime.now(datetime.timezone.utc),
'duration': datetime.timedelta(seconds=3),
'signal_payload': 1}],
callback=partial(event_callback, future=event_callback_future))
await server.run_async()
#await asyncio.sleep(1)
await client.run()
#await asyncio.sleep(1)
status = await event_callback_future
assert status == 'optIn'
message_type, message_payload = await asyncio.wait_for(client.poll(), 0.5)
assert message_type == 'oadrResponse'
message_type, message_payload = await asyncio.wait_for(client.poll(), 0.5)
assert message_type == 'oadrResponse'
#await asyncio.sleep(1) # Wait for the event to be completed
await client.stop()
await server.stop()
@pytest.mark.asyncio
async def test_request_event():
loop = asyncio.get_event_loop()
client = OpenADRClient(ven_name='myven',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=datetime.timedelta(seconds=1))
server.add_handler('on_create_party_registration', on_create_party_registration)
event_id = server.add_event(ven_id='ven123',
signal_name='simple',
signal_type='level',
intervals=[{'dtstart': datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(seconds=4),
'duration': datetime.timedelta(seconds=2),
'signal_payload': 1}],
ramp_up_period=datetime.timedelta(seconds=2),
callback=partial(event_callback))
assert server.events['ven123'][0].event_descriptor.event_status == 'far'
await server.run_async()
await client.create_party_registration()
message_type, message_payload = await client.request_event()
assert message_type == 'oadrDistributeEvent'
message_type, message_payload = await client.request_event()
assert message_type == 'oadrDistributeEvent'
await client.stop()
await server.stop()
@pytest.mark.asyncio
async def test_raw_event():
now = datetime.datetime.now(datetime.timezone.utc)
server = OpenADRServer(vtn_id='myvtn')
server.add_handler('on_create_party_registration', on_create_party_registration)
event = objects.Event(event_descriptor=objects.EventDescriptor(event_id='event001',
modification_number=0,
event_status='far',
market_context='http://marketcontext01'),
event_signals=[objects.EventSignal(signal_id='signal001',
signal_type='level',
signal_name='simple',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(minutes=10),
signal_payload=1)]),
objects.EventSignal(signal_id='signal002',
signal_type='price',
signal_name='ELECTRICITY_PRICE',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(minutes=10),
signal_payload=1)])],
targets=[objects.Target(ven_id='ven123')])
loop = asyncio.get_event_loop()
event_callback_future = loop.create_future()
server.add_raw_event(ven_id='ven123', event=event, callback=partial(event_callback, future=event_callback_future))
on_event_future = loop.create_future()
client = OpenADRClient(ven_name='myven',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
client.add_handler('on_event', partial(on_event_opt_in, future=on_event_future))
await server.run_async()
await client.run()
event = await on_event_future
assert len(event['event_signals']) == 2
result = await event_callback_future
assert result == 'optIn'
await client.stop()
await server.stop()
@pytest.mark.asyncio
async def test_create_event_with_future_as_callback():
now = datetime.datetime.now(datetime.timezone.utc)
server = OpenADRServer(vtn_id='myvtn')
server.add_handler('on_create_party_registration', on_create_party_registration)
event = objects.Event(event_descriptor=objects.EventDescriptor(event_id='event001',
modification_number=0,
event_status='far',
market_context='http://marketcontext01'),
event_signals=[objects.EventSignal(signal_id='signal001',
signal_type='level',
signal_name='simple',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(minutes=10),
signal_payload=1)]),
objects.EventSignal(signal_id='signal002',
signal_type='price',
signal_name='ELECTRICITY_PRICE',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(minutes=10),
signal_payload=1)])],
targets=[objects.Target(ven_id='ven123')])
loop = asyncio.get_event_loop()
event_callback_future = loop.create_future()
server.add_raw_event(ven_id='ven123', event=event, callback=event_callback_future)
on_event_future = loop.create_future()
client = OpenADRClient(ven_name='myven',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
client.add_handler('on_event', partial(on_event_opt_in, future=on_event_future))
await server.run_async()
await client.run()
event = await on_event_future
assert len(event['event_signals']) == 2
result = await event_callback_future
assert result == 'optIn'
await client.stop()
await server.stop()
@pytest.mark.asyncio
async def test_multiple_events_in_queue():
now = datetime.datetime.now(datetime.timezone.utc)
server = OpenADRServer(vtn_id='myvtn')
server.add_handler('on_create_party_registration', on_create_party_registration)
loop = asyncio.get_event_loop()
event_1_callback_future = loop.create_future()
event_2_callback_future = loop.create_future()
server.add_event(ven_id='ven123',
signal_name='simple',
signal_type='level',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(seconds=1),
signal_payload=1)],
callback=event_1_callback_future)
await server.run()
on_event_future = loop.create_future()
client = OpenADRClient(ven_name='ven123',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
await client.create_party_registration()
response_type, response_payload = await client.request_event()
assert response_type == 'oadrDistributeEvent'
events = response_payload['events']
assert len(events) == 1
event_id = events[0]['event_descriptor']['event_id']
request_id = response_payload['request_id']
await client.created_event(request_id=request_id,
event_id=event_id,
opt_type='optIn',
modification_number=0)
server.add_event(ven_id='ven123',
signal_name='simple',
signal_type='level',
intervals=[objects.Interval(dtstart=now + datetime.timedelta(seconds=1),
duration=datetime.timedelta(seconds=1),
signal_payload=1)],
callback=event_2_callback_future)
response_type, response_payload = await client.request_event()
assert response_type == 'oadrDistributeEvent'
events = response_payload['events']
# Assert that we still have two events in the response
assert len(events) == 2
# Wait one second and retrieve the events again
await asyncio.sleep(1)
response_type, response_payload = await client.request_event()
assert response_type == 'oadrDistributeEvent'
events = response_payload['events']
assert len(events) == 2
assert events[1]['event_descriptor']['event_status'] == 'completed'
response_type, response_payload = await client.request_event()
assert response_type == 'oadrDistributeEvent'
events = response_payload['events']
assert len(events) == 1
await asyncio.sleep(1)
response_type, response_payload = await client.request_event()
assert response_type == 'oadrDistributeEvent'
response_type, response_payload = await client.request_event()
assert response_type == 'oadrResponse'
await server.stop()
@pytest.mark.asyncio
async def test_client_event_cleanup():
now = datetime.datetime.now(datetime.timezone.utc)
server = OpenADRServer(vtn_id='myvtn')
server.add_handler('on_create_party_registration', on_create_party_registration)
loop = asyncio.get_event_loop()
event_1_callback_future = loop.create_future()
event_2_callback_future = loop.create_future()
server.add_event(ven_id='ven123',
signal_name='simple',
signal_type='level',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(seconds=1),
signal_payload=1)],
callback=event_1_callback_future)
await server.run()
client = OpenADRClient(ven_name='ven123',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
client.add_handler('on_event', on_event_opt_in)
await client.run()
await asyncio.sleep(0.5)
assert len(client.received_events) == 1
await asyncio.sleep(0.5)
await client._event_cleanup()
assert len(client.received_events) == 0
await server.stop()
await client.stop()
@pytest.mark.asyncio
async def test_cancel_event():
async def opt_in_to_event(event, future=None):
if future:
future.set_result(True)
return 'optIn'
async def on_update_event(event, future=None):
if future:
future.set_result(event)
return 'optIn'
now = datetime.datetime.now(datetime.timezone.utc)
server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=datetime.timedelta(seconds=1))
server.add_handler('on_create_party_registration', on_create_party_registration)
loop = asyncio.get_event_loop()
event_1_callback_future = loop.create_future()
event_id = server.add_event(ven_id='ven123',
signal_name='simple',
signal_type='level',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(seconds=60),
signal_payload=1)],
callback=event_1_callback_future,
response_required='always')
await server.run()
client = OpenADRClient(ven_name='ven123',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
client.add_handler('on_event', opt_in_to_event)
cancel_future = loop.create_future()
client.add_handler('on_update_event', partial(on_update_event, future=cancel_future))
await client.run()
await event_1_callback_future
server.cancel_event('ven123', event_id)
result = await cancel_future
assert utils.getmember(result, 'event_descriptor.event_status') == 'cancelled'
response_type, response_payload = await client.request_event()
assert response_type == 'oadrResponse'
await client._event_cleanup()
assert len(client.responded_events) == 0
assert len(client.received_events) == 0
await server.stop()
await client.stop()
@pytest.mark.asyncio
async def test_event_external_polling_function():
async def opt_in_to_event(event, future=None):
if future:
future.set_result(True)
return 'optIn'
async def on_update_event(event, future=None):
if future:
future.set_result(event)
return 'optIn'
async def on_poll(ven_id, future=None):
if future and not future.done():
future.set_result(True)
return objects.Event(event_descriptor=objects.EventDescriptor(event_id='event001',
modification_number=0,
event_status='far',
market_context='http://marketcontext01'),
event_signals=[objects.EventSignal(signal_id='signal001',
signal_type='level',
signal_name='simple',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(minutes=10),
signal_payload=1)]),
objects.EventSignal(signal_id='signal002',
signal_type='price',
signal_name='ELECTRICITY_PRICE',
intervals=[objects.Interval(dtstart=now,
duration=datetime.timedelta(minutes=10),
signal_payload=1)])],
targets=[objects.Target(ven_id=ven_id)])
else:
print("Returning None")
return None
loop = asyncio.get_event_loop()
now = datetime.datetime.now(datetime.timezone.utc)
server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=datetime.timedelta(seconds=1))
server.add_handler('on_create_party_registration', on_create_party_registration)
poll_fut = loop.create_future()
server.add_handler('on_poll', partial(on_poll, future=poll_fut))
await server.run()
client = OpenADRClient(ven_name='ven123',
vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b')
fut = loop.create_future()
client.add_handler('on_event', partial(opt_in_to_event, future=fut))
await client.run()
await fut
assert len(client.responded_events) == 1
assert len(client.received_events) == 1
await server.stop()
await client.stop()
|
