from openleadr import OpenADRClient, OpenADRServer, enable_default_logging, utils, messaging import pytest from functools import partial import asyncio from datetime import datetime, timedelta, timezone import logging enable_default_logging() async def on_create_party_registration(ven_name): return 'venid', 'regid' async def on_event_accepted(ven_id, event_id, opt_type, future=None): if future and future.done() is False: future.set_result(opt_type) async def good_on_event(event): return 'optIn' async def faulty_on_event(event): return None async def broken_on_event(event): raise KeyError("BOOM") @pytest.mark.asyncio async def test_client_no_event_handler(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) client = OpenADRClient(ven_name='myven', vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b') server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_handler('on_create_party_registration', on_create_party_registration) print("Running server") await server.run_async() await asyncio.sleep(0.1) print("Running client") await client.run() event_confirm_future = asyncio.get_event_loop().create_future() print("Adding event") server.add_event(ven_id='venid', event_id='test_client_no_event_handler', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=partial(on_event_accepted, future=event_confirm_future)) print("Waiting for a response to the event") result = await event_confirm_future assert result == 'optOut' assert ("You should implement your own on_event handler. This handler receives " "an Event dict and should return either 'optIn' or 'optOut' based on your " "choice. Will opt out of the event for now.") in [rec.message for rec in caplog.records] await client.stop() await server.stop() await asyncio.gather(*[t for t in asyncio.all_tasks()][1:]) @pytest.mark.asyncio async def test_client_faulty_event_handler(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) client = OpenADRClient(ven_name='myven', vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b') client.add_handler('on_event', faulty_on_event) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_handler('on_create_party_registration', on_create_party_registration) print("Running server") await server.run_async() await asyncio.sleep(0.1) print("Running client") await client.run() event_confirm_future = asyncio.get_event_loop().create_future() print("Adding event") server.add_event(ven_id='venid', event_id='test_client_faulty_event_handler', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=partial(on_event_accepted, future=event_confirm_future)) print("Waiting for a response to the event") result = await event_confirm_future assert result == 'optOut' assert ("Your on_event or on_update_event handler must return 'optIn' or 'optOut'; " f"you supplied {None}. Please fix your on_event handler.") in [rec.message for rec in caplog.records] await client.stop() await server.stop() await asyncio.gather(*[t for t in asyncio.all_tasks()][1:]) @pytest.mark.asyncio async def test_client_exception_event_handler(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) client = OpenADRClient(ven_name='myven', vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b') client.add_handler('on_event', broken_on_event) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_handler('on_create_party_registration', on_create_party_registration) print("Running server") await server.run_async() await asyncio.sleep(0.1) print("Running client") await client.run() event_confirm_future = asyncio.get_event_loop().create_future() print("Adding event") server.add_event(ven_id='venid', event_id='test_client_exception_event_handler', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=partial(on_event_accepted, future=event_confirm_future)) print("Waiting for a response to the event") result = await event_confirm_future assert result == 'optOut' err = KeyError("BOOM") assert ("Your on_event handler encountered an error. Will Opt Out of the event. " f"The error was {err.__class__.__name__}: {str(err)}") in [rec.message for rec in caplog.records] await client.stop() await server.stop() await asyncio.gather(*[t for t in asyncio.all_tasks()][1:]) @pytest.mark.asyncio async def test_client_good_event_handler(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) client = OpenADRClient(ven_name='myven', vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b') client.add_handler('on_event', good_on_event) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_handler('on_create_party_registration', on_create_party_registration) print("Running server") await server.run_async() await asyncio.sleep(0.1) print("Running client") await client.run() event_confirm_future = asyncio.get_event_loop().create_future() print("Adding event") server.add_event(ven_id='venid', event_id='test_client_good_event_handler', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=partial(on_event_accepted, future=event_confirm_future)) print("Waiting for a response to the event") result = await event_confirm_future assert result == 'optIn' assert len(caplog.records) == 0 await client.stop() await server.stop() await asyncio.sleep(1) @pytest.mark.asyncio async def test_server_warning_conflicting_poll_methods(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_handler('on_poll', print) server.add_event(ven_id='venid', event_id='test_server_warning_conflicting_poll_methods', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=on_event_accepted) assert ("You cannot use the add_event method after you assign your own on_poll " "handler. If you use your own on_poll handler, you are responsible for " "delivering events from that handler. If you want to use OpenLEADRs " "message queuing system, you should not assign an on_poll handler. " "Your Event will NOT be added.") in [record.msg for record in caplog.records] @pytest.mark.asyncio async def test_server_warning_naive_datetimes_in_event(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_event(ven_id='venid', event_id='test_server_warning_naive_datetimes_in_event', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=on_event_accepted) assert ("You supplied a naive datetime object to your interval's dtstart. " "This will be interpreted as a timestamp in your local timezone " "and then converted to UTC before sending. Please supply timezone-" "aware timestamps like datetime.datetime.new(timezone.utc) or " "datetime.datetime(..., tzinfo=datetime.timezone.utc)") in [record.msg for record in caplog.records] def test_event_with_wrong_response_required(caplog): now = datetime.now(timezone.utc) event = {'active_period': {'dtstart': now, 'duration': timedelta(seconds=10)}, 'event_descriptor': {'event_id': 'event123', 'modification_number': 1, 'priority': 0, 'event_status': 'far', 'created_date_time': now}, 'event_signals': [{'signal_name': 'simple', 'signal_type': 'level', 'intervals': [{'dtstart': now, 'duration': timedelta(seconds=10), 'signal_payload': 1}]}], 'targets': [{'ven_id': 'ven123'}], 'response_required': 'blabla'} msg = messaging.create_message('oadrDistributeEvent', events=[event]) assert ("The response_required property in an Event should be " "'never' or 'always', not blabla. Changing to 'always'.") in caplog.messages message_type, message_payload= messaging.parse_message(msg) assert message_payload['events'][0]['response_required'] == 'always' def test_event_missing_created_date_time(caplog): now = datetime.now(timezone.utc) event = {'active_period': {'dtstart': now, 'duration': timedelta(seconds=10)}, 'event_descriptor': {'event_id': 'event123', 'modification_number': 1, 'priority': 0, 'event_status': 'far'}, 'event_signals': [{'signal_name': 'simple', 'signal_type': 'level', 'intervals': [{'dtstart': now, 'duration': timedelta(seconds=10), 'signal_payload': 1}]}], 'targets': [{'ven_id': 'ven123'}], 'response_required': 'always'} msg = messaging.create_message('oadrDistributeEvent', events=[event]) assert ("Your event descriptor did not contain a created_date_time. " "This will be automatically added.") in caplog.messages def test_event_incongruent_targets(caplog): now = datetime.now(timezone.utc) event = {'active_period': {'dtstart': now, 'duration': timedelta(seconds=10)}, 'event_descriptor': {'event_id': 'event123', 'modification_number': 1, 'priority': 0, 'event_status': 'far', 'created_date_time': now}, 'event_signals': [{'signal_name': 'simple', 'signal_type': 'level', 'intervals': [{'dtstart': now, 'duration': timedelta(seconds=10), 'signal_payload': 1}]}], 'targets': [{'ven_id': 'ven123'}], 'targets_by_type': {'ven_id': ['ven456']}, 'response_required': 'always'} with pytest.raises(ValueError) as err: msg = messaging.create_message('oadrDistributeEvent', events=[event]) assert str(err.value) == ("You assigned both 'targets' and 'targets_by_type' in your event, " "but the two were not consistent with each other. " f"You supplied 'targets' = {event['targets']} and " f"'targets_by_type' = {event['targets_by_type']}") def test_event_only_targets_by_type(caplog): now = datetime.now(timezone.utc) event = {'active_period': {'dtstart': now, 'duration': timedelta(seconds=10)}, 'event_descriptor': {'event_id': 'event123', 'modification_number': 1, 'priority': 0, 'event_status': 'far', 'created_date_time': now}, 'event_signals': [{'signal_name': 'simple', 'signal_type': 'level', 'intervals': [{'dtstart': now, 'duration': timedelta(seconds=10), 'signal_payload': 1}]}], 'targets_by_type': {'ven_id': ['ven456']}, 'response_required': 'always'} msg = messaging.create_message('oadrDistributeEvent', events=[event]) message_type, message_payload = messaging.parse_message(msg) assert message_payload['events'][0]['targets'] == [{'ven_id': 'ven456'}] @pytest.mark.asyncio async def test_client_warning_no_update_event_handler(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) server.add_handler('on_create_party_registration', on_create_party_registration) server.add_event(ven_id='venid', event_id='test_client_warning_no_update_event_handler', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=on_event_accepted) client = OpenADRClient(ven_name='myven', vtn_url='http://localhost:8080/OpenADR2/Simple/2.0b') client.add_handler('on_event', good_on_event) await server.run_async() await asyncio.sleep(0.5) await client.run() await asyncio.sleep(2) assert ("You should implement your own on_update_event handler. This handler receives " "an Event dict and should return either 'optIn' or 'optOut' based on your " "choice. Will re-use the previous opt status for this event_id for now") in [record.msg for record in caplog.records] await client.stop() await server.stop() @pytest.mark.asyncio async def test_server_add_event_with_wrong_callback_signature(caplog): def dummy_callback(some_param): pass caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) server = OpenADRServer(vtn_id='myvtn', requested_poll_freq=timedelta(seconds=1)) with pytest.raises(ValueError) as err: server.add_event(ven_id='venid', event_id='test_server_add_event_with_wrong_callback_signature', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, callback=dummy_callback) @pytest.mark.asyncio async def test_server_add_event_with_no_callback(caplog): def dummy_callback(some_param): pass caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) server = OpenADRServer(vtn_id='myvtn') server.add_event(ven_id='venid', event_id='test_server_add_event_with_no_callback', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}) assert ("You did not provide a 'callback', which means you won't know if the " "VEN will opt in or opt out of your event. You should consider adding " "a callback for this.") in caplog.messages @pytest.mark.asyncio async def test_server_add_event_with_no_callback_response_never_required(caplog): caplog.set_level(logging.WARNING) logger = logging.getLogger('openleadr') logger.setLevel(logging.DEBUG) server = OpenADRServer(vtn_id='myvtn') server.add_event(ven_id='venid', event_id='test_server_add_event_with_no_callback_response_never_required', signal_name='simple', signal_type='level', intervals=[{'dtstart': datetime.now(timezone.utc), 'duration': timedelta(seconds=1), 'signal_payload': 1.1}], target={'ven_id': 'venid'}, response_required='never') await server.run() await server.stop() assert ("You did not provide a 'callback', which means you won't know if the " "VEN will opt in or opt out of your event. You should consider adding " "a callback for this.") not in caplog.messages