# SPDX-License-Identifier: Apache-2.0 # Copyright 2020 Contributors to OpenLEADR # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from pyopenadr.utils import generate_id, indent_xml from pyopenadr.messaging import create_message from pyopenadr import enums from lxml import etree import os from datetime import datetime, timedelta, timezone from termcolor import colored import jinja2 from pprint import pprint DATE_FORMAT = "%Y-%m-%dT%H:%M:%S.%fZ" SCHEMA_LOCATION = os.path.join('schema', 'oadr_20b.xsd') schema_root = etree.parse(SCHEMA_LOCATION) schema = etree.XMLSchema(schema_root) parser = etree.XMLParser(schema=schema) def create_dummy_event(ven_id): """ Creates a dummy event """ now = datetime.now(timezone.utc) event_id = generate_id() active_period = {"dtstart": now + timedelta(minutes=1), "duration": timedelta(minutes=9)} event_descriptor = {"event_id": event_id, "modification_number": 1, "modification_date_time": now, "priority": 1, "market_context": "http://MarketContext1", "created_date_time": now, "event_status": "near", "test_event": "false", "vtn_comment": "This is an event"} event_signals = [{"intervals": [{"duration": timedelta(minutes=1), "uid": 1, "signal_payload": 8}, {"duration": timedelta(minutes=1), "uid": 2, "signal_payload": 10}, {"duration": timedelta(minutes=1), "uid": 3, "signal_payload": 12}, {"duration": timedelta(minutes=1), "uid": 4, "signal_payload": 14}, {"duration": timedelta(minutes=1), "uid": 5, "signal_payload": 16}, {"duration": timedelta(minutes=1), "uid": 6, "signal_payload": 18}, {"duration": timedelta(minutes=1), "uid": 7, "signal_payload": 20}, {"duration": timedelta(minutes=1), "uid": 8, "signal_payload": 10}, {"duration": timedelta(minutes=1), "uid": 9, "signal_payload": 20}], "signal_name": "LOAD_CONTROL", #"signal_name": "simple", #"signal_type": "level", "signal_type": "x-loadControlCapacity", "signal_id": generate_id(), "current_value": 9.99}] event_targets = [{"ven_id": 'VEN001'}, {"ven_id": 'VEN002'}] event = {'active_period': active_period, 'event_descriptor': event_descriptor, 'event_signals': event_signals, 'targets': event_targets, 'response_required': 'always'} return event def test_schemas(): for message_type, content in testcases: _test_message(message_type, **content) def _test_message(msg_type, **payload): try: with open(os.path.join('example_messages', f'{msg_type}.xml'), 'w') as file: message = create_message(msg_type, **payload) print(indent_xml(message),file=file) # print(type, file=file) # print("="*len(type), file=file) # print("", file=file) # print("OpenADR payload:", file=file) # print("..code-block:xml", file=file) # print("", file=file) # print(indent_xml(message), file=file) # print("", file=file) # print("pyOpenADR representation:", file=file) # print("..code-block:python3", file=file) # print("", file=file) # pprint(payload, stream=file) etree.fromstring(message.encode('utf-8'), parser) print(colored(f"pass: {msg_type} OK", "green")) except etree.XMLSyntaxError as err: print(colored(f"fail: {msg_type} failed validation: {err}", "red")) print(message) except jinja2.exceptions.UndefinedError as err: print(colored(f"fail: {msg_type} failed message construction: {err}", "yellow")) testcases = [ ('oadrCanceledOpt', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, opt_id=generate_id())), ('oadrCanceledPartyRegistration', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, registration_id=generate_id(), ven_id='123ABC')), ('oadrCanceledReport', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, pending_reports=[{'request_id': generate_id()}, {'request_id': generate_id()}])), ('oadrCanceledReport', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, pending_reports=[{'request_id': generate_id()}, {'request_id': generate_id()}], ven_id='123ABC')), ('oadrCancelOpt', dict(request_id=generate_id(), ven_id='123ABC', opt_id=generate_id())), ('oadrCancelPartyRegistration', dict(request_id=generate_id(), ven_id='123ABC', registration_id=generate_id())), ('oadrCancelReport', dict(request_id=generate_id(), ven_id='123ABC', report_request_id=generate_id(), report_to_follow=True)), ('oadrCreatedEvent', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, event_responses=[{'response_code': 200, 'response_description': 'OK', 'request_id': generate_id(), 'event_id': generate_id(), 'modification_number': 1, 'opt_type': 'optIn'}, {'response_code': 200, 'response_description': 'OK', 'request_id': generate_id(), 'event_id': generate_id(), 'modification_number': 1, 'opt_type': 'optIn'}, {'response_code': 200, 'response_description': 'OK', 'request_id': generate_id(), 'event_id': generate_id(), 'modification_number': 1, 'opt_type': 'optIn'}], ven_id='123ABC')), ('oadrCreatedReport', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, pending_reports=[{'request_id': generate_id()}, {'request_id': generate_id()}], ven_id='123ABC')), ('oadrCreatedEvent', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, event_responses=[{'response_code': 200, 'response_description': 'OK', 'request_id': generate_id(), 'event_id': generate_id(), 'modification_number': 1, 'opt_type': 'optIn'}, {'response_code': 200, 'response_description': 'OK', 'request_id': generate_id(), 'event_id': generate_id(), 'modification_number': 1, 'opt_type': 'optOut'}], ven_id='123ABC')), ('oadrCreatedPartyRegistration', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, registration_id=generate_id(), ven_id='123ABC', profiles=[{'profile_name': '2.0b', 'transports': [{'transport_name': 'simpleHttp'}]}], vtn_id='VTN123')), ('oadrCreatedReport', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, pending_reports=[{'request_id': generate_id()}, {'request_id': generate_id()}])), ('oadrCreateOpt', dict(opt_id=generate_id(), opt_type='optIn', opt_reason='participating', created_date_time=datetime.now(timezone.utc), request_id=generate_id(), event_id=generate_id(), modification_number=1, targets=[{'ven_id': '123ABC'}], ven_id='VEN123')), ('oadrCreatePartyRegistration', dict(request_id=generate_id(), ven_id='123ABC', profile_name='2.0b', transport_name='simpleHttp', transport_address='http://localhost', report_only=False, xml_signature=False, ven_name='test', http_pull_model=True)), ('oadrCreateReport', dict(request_id=generate_id(), ven_id='123ABC', report_requests=[{'report_request_id': 'd2b7bade5f', 'report_specifier': {'granularity': timedelta(seconds=900), 'report_back_duration': timedelta(seconds=900), 'report_interval': {'dtstart': datetime(2019, 11, 19, 11, 0, 18, 672768, tzinfo=timezone.utc), 'duration': timedelta(seconds=7200), 'tolerance': {'tolerate': {'startafter': timedelta(seconds=300)}}}, 'report_specifier_id': '9c8bdc00e7', 'specifier_payload': {'r_id': 'd6e2e07485', 'reading_type': 'Direct Read'}}}])), ('oadrDistributeEvent', dict(request_id=generate_id(), response={'request_id': 123, 'response_code': 200, 'response_description': 'OK'}, events=[create_dummy_event(ven_id='123ABC')], vtn_id='VTN123')), ('oadrPoll', dict(ven_id='123ABC')), ('oadrQueryRegistration', dict(request_id=generate_id())), ('oadrRegisteredReport', dict(ven_id='VEN123', response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, report_requests=[{'report_request_id': generate_id(), 'report_specifier': {'report_specifier_id': generate_id(), 'granularity': timedelta(minutes=15), 'report_back_duration': timedelta(minutes=15), 'report_interval': {'dtstart': datetime.now(timezone.utc), 'duration': timedelta(hours=2), 'tolerance': {'tolerate': {'startafter': timedelta(minutes=5)}}, 'notification': timedelta(minutes=30), 'ramp_up': timedelta(minutes=15), 'recovery': timedelta(minutes=5)}, 'specifier_payload': {'r_id': generate_id(), 'reading_type': 'Direct Read'}}}, {'report_request_id': generate_id(), 'report_specifier': {'report_specifier_id': generate_id(), 'granularity': timedelta(minutes=15), 'report_back_duration': timedelta(minutes=15), 'report_interval': {'dtstart': datetime.now(timezone.utc), 'duration': timedelta(hours=2), 'tolerance': {'tolerate': {'startafter': timedelta(minutes=5)}}, 'notification': timedelta(minutes=30), 'ramp_up': timedelta(minutes=15), 'recovery': timedelta(minutes=5)}, 'specifier_payload': {'r_id': generate_id(), 'reading_type': 'Direct Read'}}}])), ('oadrRequestEvent', dict(request_id=generate_id(), ven_id='123ABC')), ('oadrRequestReregistration', dict(ven_id='123ABC')), ('oadrRegisterReport', dict(request_id=generate_id(), reports=[{'report_id': generate_id(), 'report_descriptions': { generate_id(): { 'report_subjects': [{'ven_id': '123ABC'}], 'report_data_sources': [{'ven_id': '123ABC'}], 'report_type': 'reading', 'reading_type': 'Direct Read', 'market_context': 'http://localhost', 'sampling_rate': {'min_period': timedelta(minutes=1), 'max_period': timedelta(minutes=1), 'on_change': True}}}, 'report_request_id': generate_id(), 'report_specifier_id': generate_id(), 'report_name': 'HISTORY_USAGE', 'created_date_time': datetime.now(timezone.utc)}], ven_id='123ABC', report_request_id=generate_id())), ('oadrRegisterReport', {'request_id': '8a4f859883', 'reports': [{'report_id': generate_id(), 'duration': timedelta(seconds=7200), 'report_descriptions': {'resource1_status': { 'report_data_sources': [{'resource_id': 'resource1'}], 'report_type': 'x-resourceStatus', 'reading_type': 'x-notApplicable', 'market_context': 'http://MarketContext1', 'sampling_rate': {'min_period': timedelta(seconds=60), 'max_period': timedelta(seconds=60), 'on_change': False}}}, 'report_request_id': '0', 'report_specifier_id': '789ed6cd4e_telemetry_status', 'report_name': 'METADATA_TELEMETRY_STATUS', 'created_date_time': datetime(2019, 11, 20, 15, 4, 52, 638621, tzinfo=timezone.utc)}, {'report_id': generate_id(), 'duration': timedelta(seconds=7200), 'report_descriptions': {'resource1_energy': { 'report_data_sources': [{'resource_id': 'resource1'}], 'report_type': 'usage', 'energy_real': {'item_description': 'RealEnergy', 'item_units': 'Wh', 'si_scale_code': 'n'}, 'reading_type': 'Direct Read', 'market_context': 'http://MarketContext1', 'sampling_rate': {'min_period': timedelta(seconds=60), 'max_period': timedelta(seconds=60), 'on_change': False}}, 'resource1_power': { 'report_data_sources': [{'resource_id': 'resource1'}], 'report_type': 'usage', 'power_real': {'item_description': 'RealPower', 'item_units': 'W', 'si_scale_code': 'n', 'power_attributes': {'hertz': 60, 'voltage': 110, 'ac': False}}, 'reading_type': 'Direct Read', 'market_context': 'http://MarketContext1', 'sampling_rate': {'min_period': timedelta(seconds=60), 'max_period': timedelta(seconds=60), 'on_change': False}}}, 'report_request_id': '0', 'report_specifier_id': '789ed6cd4e_telemetry_usage', 'report_name': 'METADATA_TELEMETRY_USAGE', 'created_date_time': datetime(2019, 11, 20, 15, 4, 52, 638621, tzinfo=timezone.utc)}, {'report_id': generate_id(), 'duration': timedelta(seconds=7200), 'report_descriptions': {'resource1_energy': { 'report_data_sources': [{'resource_id': 'resource1'}], 'report_type': 'usage', 'energy_real': {'item_description': 'RealEnergy', 'item_units': 'Wh', 'si_scale_code': 'n'}, 'reading_type': 'Direct Read', 'market_context': 'http://MarketContext1', 'sampling_rate': {'min_period': timedelta(seconds=60), 'max_period': timedelta(seconds=60), 'on_change': False}}, 'resource1_power': { 'report_data_sources': [{'resource_id': 'resource1'}], 'report_type': 'usage', 'power_real': {'item_description': 'RealPower', 'item_units': 'W', 'si_scale_code': 'n', 'power_attributes': {'hertz': 60, 'voltage': 110, 'ac': False}}, 'reading_type': 'Direct Read', 'market_context': 'http://MarketContext1', 'sampling_rate': {'min_period': timedelta(seconds=60), 'max_period': timedelta(seconds=60), 'on_change': False}}}, 'report_request_id': '0', 'report_specifier_id': '789ed6cd4e_history_usage', 'report_name': 'METADATA_HISTORY_USAGE', 'created_date_time': datetime(2019, 11, 20, 15, 4, 52, 638621, tzinfo=timezone.utc)}], 'ven_id': 's3cc244ee6'}), ('oadrResponse', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, ven_id='123ABC')), ('oadrResponse', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': None}, ven_id='123ABC')), ('oadrUpdatedReport', dict(response={'response_code': 200, 'response_description': 'OK', 'request_id': generate_id()}, ven_id='123ABC', cancel_report={'request_id': generate_id(), 'report_request_id': [generate_id(), generate_id(), generate_id()], 'report_to_follow': False, 'ven_id': '123ABC'})), ('oadrUpdateReport', dict(request_id=generate_id(), reports=[{'report_id': generate_id(), 'report_name': enums.REPORT_NAME.values[0], 'created_date_time': datetime.now(timezone.utc), 'report_request_id': generate_id(), 'report_specifier_id': generate_id(), 'report_descriptions': {generate_id(): {'report_subjects': [{'ven_id': '123ABC'}, {'ven_id': 'DEF456'}], 'report_data_sources': [{'ven_id': '123ABC'}], 'report_type': enums.REPORT_TYPE.values[0], 'reading_type': enums.READING_TYPE.values[0], 'market_context': 'http://localhost', 'sampling_rate': {'min_period': timedelta(minutes=1), 'max_period': timedelta(minutes=2), 'on_change': False}}}}], ven_id='123ABC')) ]