Merge branch 'master' into validation

.github/ISSUE_TEMPLATE/documentation_request.md

@@ -0,0 +1,11 @@
+---
+name: Documentation request
+about: Suggest documentation for this project
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Describe the documentation you'd like**
+A clear and concise description of what you'd want documented.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.rst

@@ -11,7 +11,7 @@ OCPP
 ----
 
 Python package implementing the JSON version of the Open Charge Point Protocol
-(OCPP). Currently OCPP 1.6 (errata v4), OCPP 2.0.1 (Edition 2 FINAL, 2022-12-15)
+(OCPP). Currently OCPP 1.6 (errata v4), OCPP 2.0.1 (Edition 2 FINAL, 2022-12-15 and Edition 3 errata 2024-11)
 are supported.
 
 You can find the documentation on `rtd`_.

ocpp/charge_point.py

@@ -295,9 +295,8 @@ async def _handle_call(self, msg):
             return
 
         if not handlers.get("_skip_schema_validation", False):
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, msg, self._ocpp_version
-            )
+            await validate_payload(msg, self._ocpp_version)
+
         # OCPP uses camelCase for the keys in the payload. It's more pythonic
         # to use snake_case for keyword arguments. Therefore the keys must be
         # 'translated'. Some examples:
@@ -344,9 +343,7 @@ async def _handle_call(self, msg):
         response = msg.create_call_result(camel_case_payload)
 
         if not handlers.get("_skip_schema_validation", False):
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, response, self._ocpp_version
-            )
+            await validate_payload(response, self._ocpp_version)
 
         await self._send(response.to_json())
 
@@ -415,9 +412,7 @@ async def call(
         )
 
         if not skip_schema_validation:
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, call, self._ocpp_version
-            )
+            await validate_payload(call, self._ocpp_version)
 
         # Use a lock to prevent make sure that only 1 message can be send at a
         # a time.
@@ -440,9 +435,7 @@ async def call(
             raise response.to_exception()
         elif not skip_schema_validation:
             response.action = call.action
-            await asyncio.get_event_loop().run_in_executor(
-                None, validate_payload, response, self._ocpp_version
-            )
+            await validate_payload(response, self._ocpp_version)
 
         snake_case_payload = camel_to_snake_case(response.payload)
         # Create the correct Payload instance based on the received payload. If

ocpp/exceptions.py

@@ -49,7 +49,7 @@ class InternalError(OCPPError):
     code = "InternalError"
     default_description = (
         "An internal error occurred and the receiver was "
-        "able to process the requested Action successfully"
+        "not able to process the requested Action successfully"
     )
 
 

ocpp/messages.py

@@ -1,7 +1,9 @@
 """ Module containing classes that model the several OCPP messages types. It
 also contain some helper functions for packing and unpacking messages.  """
+
 from __future__ import annotations
 
+import asyncio
 import decimal
 import json
 import os
@@ -23,6 +25,8 @@
 
 _validators: Dict[str, Draft4Validator] = {}
 
+ASYNC_VALIDATION = True
+
 
 class _DecimalEncoder(json.JSONEncoder):
     """Encode values of type `decimal.Decimal` using 1 decimal point.
@@ -168,8 +172,17 @@ def get_validator(
     return _validators[cache_key]
 
 
-def validate_payload(message: Union[Call, CallResult], ocpp_version: str) -> None:
+async def validate_payload(message: Union[Call, CallResult], ocpp_version: str) -> None:
     """Validate the payload of the message using JSON schemas."""
+    if ASYNC_VALIDATION:
+        await asyncio.get_event_loop().run_in_executor(
+            None, _validate_payload, message, ocpp_version
+        )
+    else:
+        _validate_payload(message, ocpp_version)
+
+
+def _validate_payload(message: Union[Call, CallResult], ocpp_version: str) -> None:
     if type(message) not in [Call, CallResult]:
         raise ValidationError(
             "Payload can't be validated because message "

tests/test_exceptions.py

@@ -5,7 +5,7 @@
     ProtocolError,
     TypeConstraintViolationError,
 )
-from ocpp.messages import Call, validate_payload
+from ocpp.messages import Call, _validate_payload
 
 
 def test_exception_with_error_details():
@@ -36,7 +36,7 @@ def test_exception_show_triggered_message_type_constraint():
     )
 
     with pytest.raises(TypeConstraintViolationError) as exception_info:
-        validate_payload(call, "1.6")
+        _validate_payload(call, "1.6")
     assert ocpp_message in str(exception_info.value)
 
 
@@ -54,5 +54,5 @@ def test_exception_show_triggered_message_format():
     )
 
     with pytest.raises(FormatViolationError) as exception_info:
-        validate_payload(call, "1.6")
+        _validate_payload(call, "1.6")
     assert ocpp_message in str(exception_info.value)

tests/test_messages.py

@@ -1,11 +1,13 @@
 import decimal
 import json
+import threading
 from datetime import datetime
 
 import pytest
 from hypothesis import given
 from hypothesis.strategies import binary
 
+import ocpp
 from ocpp.exceptions import (
     FormatViolationError,
     PropertyConstraintViolationError,
@@ -20,6 +22,7 @@
     CallResult,
     MessageType,
     _DecimalEncoder,
+    _validate_payload,
     _validators,
     get_validator,
     pack,
@@ -136,7 +139,7 @@ def test_validate_set_charging_profile_payload():
         },
     )
 
-    validate_payload(message, ocpp_version="1.6")
+    _validate_payload(message, ocpp_version="1.6")
 
 
 def test_validate_get_composite_profile_payload():
@@ -161,7 +164,7 @@ def test_validate_get_composite_profile_payload():
         },
     )
 
-    validate_payload(message, ocpp_version="1.6")
+    _validate_payload(message, ocpp_version="1.6")
 
 
 @pytest.mark.parametrize("ocpp_version", ["1.6", "2.0.1"])
@@ -176,7 +179,7 @@ def test_validate_payload_with_valid_payload(ocpp_version):
         payload={"currentTime": datetime.now().isoformat()},
     )
 
-    validate_payload(message, ocpp_version=ocpp_version)
+    _validate_payload(message, ocpp_version=ocpp_version)
 
 
 def test_validate_payload_with_invalid_additional_properties_payload():
@@ -191,7 +194,7 @@ def test_validate_payload_with_invalid_additional_properties_payload():
     )
 
     with pytest.raises(FormatViolationError):
-        validate_payload(message, ocpp_version="1.6")
+        _validate_payload(message, ocpp_version="1.6")
 
 
 def test_validate_payload_with_invalid_type_payload():
@@ -211,7 +214,7 @@ def test_validate_payload_with_invalid_type_payload():
     )
 
     with pytest.raises(TypeConstraintViolationError):
-        validate_payload(message, ocpp_version="1.6")
+        _validate_payload(message, ocpp_version="1.6")
 
 
 def test_validate_payload_with_invalid_missing_property_payload():
@@ -231,7 +234,7 @@ def test_validate_payload_with_invalid_missing_property_payload():
     )
 
     with pytest.raises(ProtocolError):
-        validate_payload(message, ocpp_version="1.6")
+        _validate_payload(message, ocpp_version="1.6")
 
 
 def test_validate_payload_with_invalid_message_type_id():
@@ -240,7 +243,7 @@ def test_validate_payload_with_invalid_message_type_id():
     a message type id other than 2, Call, or 3, CallError.
     """
     with pytest.raises(ValidationError):
-        validate_payload(dict(), ocpp_version="1.6")
+        _validate_payload(dict(), ocpp_version="1.6")
 
 
 def test_validate_payload_with_non_existing_schema():
@@ -255,7 +258,7 @@ def test_validate_payload_with_non_existing_schema():
     )
 
     with pytest.raises(ValidationError):
-        validate_payload(message, ocpp_version="1.6")
+        _validate_payload(message, ocpp_version="1.6")
 
 
 def test_call_error_representation():
@@ -341,7 +344,7 @@ def test_serializing_custom_types():
     )
 
     try:
-        validate_payload(message, ocpp_version="1.6")
+        _validate_payload(message, ocpp_version="1.6")
     except TypeConstraintViolationError as error:
         # Before  the fix, this call would fail with a TypError. Lack of any error
         # makes this test pass.
@@ -375,7 +378,7 @@ def test_validate_meter_values_hertz():
         },
     )
 
-    validate_payload(message, ocpp_version="1.6")
+    _validate_payload(message, ocpp_version="1.6")
 
 
 def test_validate_set_maxlength_violation_payload():
@@ -393,4 +396,25 @@ def test_validate_set_maxlength_violation_payload():
     )
 
     with pytest.raises(TypeConstraintViolationError):
-        validate_payload(message, ocpp_version="1.6")
+        _validate_payload(message, ocpp_version="1.6")
+
+
+@pytest.mark.parametrize("use_threads", [False, True])
+@pytest.mark.asyncio
+async def test_validate_payload_threads(use_threads):
+    """
+    Test that threads usage can be configured
+    """
+    message = CallResult(
+        unique_id="1234",
+        action="Heartbeat",
+        payload={"currentTime": datetime.now().isoformat()},
+    )
+
+    assert threading.active_count() == 1
+    ocpp.messages.ASYNC_VALIDATION = use_threads
+    await validate_payload(message, ocpp_version="1.6")
+    if use_threads:
+        assert threading.active_count() > 1
+    else:
+        assert threading.active_count() == 1