openmodule 14.2.0rc0__tar.gz → 14.3.0__tar.gz

{openmodule-14.2.0rc0 → openmodule-14.3.0}/ChangeLog

@@ -1,13 +1,11 @@
 CHANGES
 =======
 
-v14.2.0.rc0
------------
+v14.3.0
+-------
 
-* improvements for signal simulator
-* test util for signals
-* fixed testcase
-* added SignalListener
+* Om 912: SignalListener and SignalSimulator for testcases
+* OM-1001: CostEntryData from settings models, added valid\_from and valid\_to to AccessCheckAccess and type hints for io/signals and io/inputs settings
 
 v14.1.1
 -------
@@ -180,6 +178,16 @@ v12.0.0
 * settings model 1.0
 * small fix in test utils
 
+v12.0.0.rc1
+-----------
+
+* removed debug entries from kv store removed cost\_entries from AccessCheckAccess
+
+v12.0.0.rc0
+-----------
+
+* Removed parking\_area\_id from AccessCheckAccess changed gate permission check in AccessService to new behavior
+
 v11.1.1
 -------
 
@@ -194,3 +202,6 @@ v11.1.0
 v11.0.3
 -------
 
+* Fixed typo, added compute\_id as label to all metrics, convert all label values to string
+* touch to get rid of skip ci on my commit
+* docs update [skip ci]

{openmodule-14.2.0rc0/openmodule.egg-info → openmodule-14.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmodule
-Version: 14.2.0rc0
+Version: 14.3.0
 Summary: Libraries for developing the arivo openmodule
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO

{openmodule-14.2.0rc0 → openmodule-14.3.0}/docs/testing.md

@@ -267,6 +267,23 @@ presence_sim.enter(self.presence_sim.vehicle().lpr("A", "G ARIVO1"))
 on_enter.wait_for_call()
 ```
 
+### SignalSimulator
+
+Util class for simulating signals
+
+```python
+signal_simulator = SignalSimulator(lambda x: core().publish(x, "signal"))
+# add_signal registers signals for RPC callbacks but does not emit signal message
+signal_simulator.add_signal(False, None, SignalType.open, gate="einfahrt")  # generates correct signal einfahrt-open
+signal_simulator.add_signal(True, {"a": "b"}, SignalType.custom, signal_name="custom1")
+# (change and) emit signals message
+signal_simulator.set_signal("einfahrt-open", True)
+signal_simulator.set_signal("custom1", True, {"a": "c"})
+# register signal RPCs with callbacks from signal_simulator, which will automatically answer with correct response
+rpc_server.register_handler("signal", "trigger_signals", TriggerSignalsRequest, TriggerSignalsResponse, 
+                            signal_simulator.trigger_signal_callback, register_schema=False)
+```
+
 ### MockRPCClient
 
 This is a fake RPCClient where you can either specify callback functions for RPCs or even the responses.

{openmodule-14.2.0rc0 → openmodule-14.3.0}/docs/utils.md

@@ -15,7 +15,28 @@ presence_listener = PresenceListener(core.messages)
 presence_listener.on_enter.append(some_function)
 ```
 
-### Databox Upload
+## Signals
+
+Helper class for listening on signals. 
+```python
+from openmodule.utils.signal_listener import SignalListener, FilterType
+
+signal_listener = SignalListener(core.messages, core.rpc_client)
+# register a listener for a signal with a filter_type specifying when the function should be called and optional tag
+signal_listener.add_listener("gate1-open", FilterType.any_edge, some_function, tag="tag1")
+signal_listener.add_listener("gate2-present_decision", FilterType.any_change, some_function2, tag="tag2")
+# get the current value (and additional_data) of a signal, if unknown then RPC is called to get value
+value = signal_listener.get_value("gate1-open")  
+value, additional_data = signal_listener.get_value_and_additional_data("gate1-open")  
+# trigger resending of signals via trigger_signals RPC for registered signals with specific tag 
+# or all registered signals if tag is None
+signal_listener.trigger_signals(tag="tag1")
+# remove listeners with specific tag or all if tag is None
+signal_listener.remove_listener(tag="tag1")
+```
+
+
+## Databox Upload
 
 In the openmodule we have a utils function to simplify the upload with the databox service. The prerequisite is, 
 that the upload folder `/data/om_service_databox_1/upload` is mounted correctly in the compose file to the `settings.DATABOX_UPLOAD_DIR` (default: `/upload`)

{openmodule-14.2.0rc0 → openmodule-14.3.0}/openmodule/models/access_service.py

@@ -65,12 +65,17 @@ class AccessCheckAccess(OpenModuleModel):
     category: AccessCategory           # category used for sorting and eventlog
     used_medium: Medium                # medium of the access
     access_data: Dict                  # complete access data, will be used only for display and debug purposes
+    valid_from: Optional[datetime]     # access is valid from this time. Only used for reservations
+    valid_to: Optional[datetime]       # access is valid until this time. Only used for reservations
 
     accepted: bool                     # if access service decided access can enter
     reject_reason: Optional[AccessCheckRejectReason]  # only if not accepted: reason for not accepted
     # additional infos shown in events if reject reason is "custom". Required if reject_reason == "custom"
     supplementary_infos: Optional[str]
 
+    _tz_valid_from = timezone_validator("valid_from")
+    _tz_valid_to = timezone_validator("valid_to")
+
     @root_validator(skip_on_failure=True)
     def root_validation(cls, values):
         # if category is handauf, medium_display_name must be set

{openmodule-14.2.0rc0 → openmodule-14.3.0}/openmodule/models/base.py

@@ -5,16 +5,17 @@ from datetime import datetime
 from decimal import Decimal
 from enum import Enum
 from json.encoder import ESCAPE_ASCII
-from typing import Optional, Union
+from typing import Optional, Union, Dict
 
 import orjson
 import zmq
 from dateutil.tz import UTC
-from pydantic import Field, BaseModel, validator, root_validator
+from pydantic import Field, BaseModel, validator
 from pydantic.main import ROOT_KEY
 
 from openmodule import config, sentry
 from openmodule.config import settings
+from settings_models.settings.common import CostEntryData as SettingsModelsCostEntryData
 
 
 def _donotuse(v, *, default):
@@ -171,20 +172,5 @@ class Gateway(OpenModuleModel):
         return f"{self.gate}/{self.direction}"
 
 
-class CostEntryData(OpenModuleModel):
-    entry_type: str
-    value: Optional[Union[int, str]]
-    group: Optional[str]
-    account_id: str
-    source: Optional[str]  # if None, source will be set to service name on default: e.g. "service_iocontroller"
-    source_id: Optional[str]
-    idempotency_key: Optional[str]
-
-    @root_validator
-    def set_value_type(cls, values):
-        if values["entry_type"] in ["rate_change", "rate_validation", "partial_rate_change"]:
-            values["value"] = str(values["value"])
-        elif values["entry_type"] in ["static_cost", "pending_static_cost", "amount_validation", "time_validation"
-                                      "payment"]:
-            values["value"] = int(values["value"])
-        return values
+# to be not breaking
+CostEntryData = SettingsModelsCostEntryData

openmodule-14.2.0rc0/openmodule/models/signal.py → openmodule-14.3.0/openmodule/models/signals.py

@@ -20,10 +20,10 @@ class SignalType(str, Enum):
 class SignalMessage(ZMQMessage):
     signal: str
     type: Union[SignalType, str]  # union so we can add new types without updating all services using signals
-    gate: Optional[str]
-    parking_area_id: Optional[str]
+    gate: Optional[str] = None
+    parking_area_id: Optional[str] = None
     value: bool
-    additional_data: Optional[Dict]
+    additional_data: Optional[Dict] = None
 
 
 class GetSignalValueRequest(OpenModuleModel):
@@ -32,7 +32,7 @@ class GetSignalValueRequest(OpenModuleModel):
 
 class GetSignalValueResponse(OpenModuleModel):
     value: bool
-    additional_data: Optional[Dict]
+    additional_data: Optional[Dict] = None
 
 
 class TriggerSignalsRequest(OpenModuleModel):

{openmodule-14.2.0rc0 → openmodule-14.3.0}/openmodule/rpc/client.py

@@ -2,7 +2,7 @@ import logging
 import threading
 import time
 import warnings
-from typing import Dict, Optional, List, Type
+from typing import Dict, Optional, List, Type, TypeVar
 from uuid import uuid4
 
 import pydantic
@@ -18,6 +18,9 @@ from openmodule.models.rpc import RPCResponse, RPCRequest, RPCErrorResult, RPCSe
 from openmodule.rpc.common import channel_to_response_topic, channel_to_request_topic
 
 
+ResponseType = TypeVar('ResponseType', bound=OpenModuleModel)
+
+
 class RPCClient:
     class Exception(Exception):
         pass
@@ -54,11 +57,11 @@ class RPCClient:
             self.ready = threading.Event()
             self.cancelled = False
 
-        def done(self):
+        def done(self) -> bool:
             return bool(self.response)
 
         @sentry.trace(op="rpc.result")
-        def result(self, response_type: Type[OpenModuleModel], timeout=None):
+        def result(self, response_type: Type[ResponseType], timeout=None)-> ResponseType:
             if timeout and (timeout > self.timeout):
                 warnings.warn("You cannot extend the timeout of an RPC after sending the request. "
                               "The timeout will be limited to at most the initial timeout.", stacklevel=2)
@@ -91,8 +94,8 @@ class RPCClient:
                     elif error_result.status == RPCServerError.error:
                         raise RPCClient.RPCServerError(error_result.error)
                     else:
-                        assert RPCClient.ServerUnknownError("RPCErrorResult successfully parsed but status not handled."
-                                                            " Implement this!")
+                        raise RPCClient.ServerUnknownError("RPCErrorResult successfully parsed but status not handled."
+                                                           " Implement this!")
             except pydantic.ValidationError as e:
                 raise RPCClient.ValidationError(e.raw_errors, e.model)
 
@@ -158,7 +161,7 @@ class RPCClient:
                 self.results.pop(rpc_id, None)
             self.sent_ids = {k: v for k, v in self.sent_ids.items() if v > now}
 
-    def _call(self, channel: str, typ: str, request: Dict, timeout: float):
+    def _call(self, channel: str, typ: str, request: Dict, timeout: float) -> RPCEntry:
         rpc_id = str(uuid4())
 
         request = RPCRequest(rpc_id=rpc_id, name=settings.NAME, request=request, type=typ)
@@ -191,8 +194,8 @@ class RPCClient:
 
             return self._call(channel, type, request, timeout)
 
-    def rpc(self, channel: str, type: str, request: [Dict, BaseModel], response_type: Type[OpenModuleModel],
-            timeout: float = None) -> OpenModuleModel:
+    def rpc(self, channel: str, type: str, request: [Dict, BaseModel], response_type: Type[ResponseType],
+            timeout: float = None) -> ResponseType:
         with sentry.trace(name=f"{channel}/{type}", op="rpc"):
             entry = self.rpc_non_blocking(channel, type, request, timeout)
             return entry.result(response_type, timeout=timeout)

{openmodule-14.2.0rc0 → openmodule-14.3.0}/openmodule/utils/settings.py

@@ -10,6 +10,7 @@ from settings_models.settings.device_keys import PairingKey, Certificate, Otp
 from settings_models.settings.enforcement import EnforcementSettings
 from settings_models.settings.gate_control import GateMode, DayMode
 from settings_models.settings.intercom import IntercomSettings
+from settings_models.settings.io import SignalDefinitions, InputDefinitions
 
 from openmodule import sentry
 from openmodule.core import core
@@ -195,6 +196,14 @@ class SettingsProvider:
     def get(self, key: Literal["feature_flags"]) -> dict:  # pragma: no cover
         ...
 
+    @overload
+    def get(self, key: Literal["io/signals"]) -> SignalDefinitions:  # pragma: no cover
+        ...
+
+    @overload
+    def get(self, key: Literal["io/inputs"]) -> InputDefinitions:  # pragma: no cover
+        ...
+
     def get(self, key: str, scope: str = "", custom_type: Optional[Type[T]] = None) -> Optional[T]:
         key_scope = join_key(key, scope)
         with self._cache_lock:

openmodule-14.2.0rc0/openmodule/utils/signal.py → openmodule-14.3.0/openmodule/utils/signal_listener.py

@@ -5,7 +5,7 @@ from typing import Optional, Dict, Callable, List, Tuple
 
 import zmq
 from openmodule.dispatcher import MessageDispatcher
-from openmodule.models.signal import SignalMessage, SignalType, GetSignalValueRequest, GetSignalValueResponse, \
+from openmodule.models.signals import SignalMessage, SignalType, GetSignalValueRequest, GetSignalValueResponse, \
     TriggerSignalsRequest, TriggerSignalsResponse
 from openmodule.rpc import RPCClient
 
@@ -56,10 +56,10 @@ class Signal:
 class Listener:
     def __init__(self, signal_name: str, filter_type: FilterType, callback: Callable[[Signal], None],
                  tag: Optional[str]):
-        self.signal_name = signal_name
-        self.filter_type = filter_type
-        self.callback = callback
-        self.tag = tag
+        self.signal_name: str = signal_name
+        self.filter_type: FilterType = filter_type
+        self.callback: Callable[[Signal], None] = callback
+        self.tag: Optional[str] = tag
 
     def matches(self, signal_name: str, change_type: ChangeType) -> bool:
         return self.signal_name == signal_name and self.filter_type.matches_change(change_type)
@@ -128,6 +128,7 @@ class SignalListener:
     def trigger_signals(self, tag: Optional[str] = None, timeout: float = 3.0) -> bool:
         """
         :param tag: if given, only signals of listeners with given tag are triggered
+        :param timeout: timeout for trigger RPC. Default is 3.0
         """
         try:
             with self.listeners_lock:
@@ -163,12 +164,12 @@ class SignalListener:
             for listener in self.listeners:
                 """
                 Handles the registered listeners the same as the dispatcher.
-                Is copied here because all messages are needed to keep current_states up to date.            
+                Is copied here because all messages are needed to keep current_states up to date.
                 """
                 if listener.matches(message.signal, change_type):
                     try:
                         listener.callback(Signal(message, change_type))
                     except zmq.ContextTerminated:
                         raise
-                    except Exception as e:
+                    except Exception:
                         self.log.exception("Error in signal callback")

{openmodule-14.2.0rc0 → openmodule-14.3.0/openmodule.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmodule
-Version: 14.2.0rc0
+Version: 14.3.0
 Summary: Libraries for developing the arivo openmodule
 Home-page: https://gitlab.com/arivo-public/device-python/openmodule.git
 Author: ARIVO

{openmodule-14.2.0rc0 → openmodule-14.3.0}/openmodule.egg-info/SOURCES.txt

@@ -74,7 +74,7 @@ openmodule/models/presence.py
 openmodule/models/privacy.py
 openmodule/models/rpc.py
 openmodule/models/settings.py
-openmodule/models/signal.py
+openmodule/models/signals.py
 openmodule/models/validation.py
 openmodule/models/vehicle.py
 openmodule/rpc/__init__.py
@@ -97,7 +97,7 @@ openmodule/utils/package_reader.py
 openmodule/utils/presence.py
 openmodule/utils/schema.py
 openmodule/utils/settings.py
-openmodule/utils/signal.py
+openmodule/utils/signal_listener.py
 openmodule/utils/translation.py
 openmodule/utils/validation.py
 openmodule_commands/__init__.py
@@ -123,7 +123,7 @@ openmodule_test/sentry.py
 openmodule_test/settings.py
 openmodule_test/setup.cfg
 openmodule_test/setup.py
-openmodule_test/signal.py
+openmodule_test/signal_simulator.py
 openmodule_test/utils.py
 openmodule_test/zeromq.py
 tests/__init__.py

openmodule-14.3.0/openmodule.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "d1f88e5", "is_release": true}

{openmodule-14.2.0rc0 → openmodule-14.3.0}/openmodule.egg-info/requires.txt

@@ -9,7 +9,7 @@ alembic<2,>=1.5.4
 requests~=2.32
 python-dateutil>=2.7.2
 python-dotenv==0.15.0
-arivo-settings_models<2,>=1.2.0
+arivo-settings_models<2,>=1.3.0
 arivo-schedule~=1.2.2
 
 [commands]

openmodule-14.2.0rc0/openmodule_test/signal.py → openmodule-14.3.0/openmodule_test/signal_simulator.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional
 
-from openmodule.models.signal import SignalMessage, TriggerSignalsRequest, TriggerSignalsResponse, \
+from openmodule.models.signals import SignalMessage, TriggerSignalsRequest, TriggerSignalsResponse, \
     GetSignalValueRequest, GetSignalValueResponse, SignalType
 from openmodule.rpc import RPCClient
 
@@ -18,7 +18,7 @@ class SignalSimulator:
             signal_msg = SignalMessage(signal=signal_name, type=signal_type, gate=gate, parking_area_id=parking_area_id,
                                        value=value, additional_data=additional_data)
         elif signal_type == SignalType.parkinglot_full:
-            signal_name = "parkinglot_full"
+            signal_name = signal_type.value
             signal_msg = SignalMessage(signal=signal_name, type=signal_type,
                                        value=value, additional_data=additional_data)
         elif signal_type == SignalType.area_full:

{openmodule-14.2.0rc0 → openmodule-14.3.0}/requirements.txt

@@ -9,5 +9,5 @@ alembic>=1.5.4,<2
 requests~=2.32
 python-dateutil>=2.7.2
 python-dotenv==0.15.0
-arivo-settings_models>=1.2.0,<2
+arivo-settings_models>=1.3.0,<2
 arivo-schedule~=1.2.2

{openmodule-14.2.0rc0 → openmodule-14.3.0}/tests/test_model.py

@@ -1,5 +1,4 @@
 import json
-
 from datetime import datetime, timedelta
 from typing import Optional
 from unittest import TestCase
@@ -8,8 +7,7 @@ import freezegun
 import orjson
 from pydantic import ValidationError
 
-from openmodule import sentry
-from openmodule.models.base import OpenModuleModel, ZMQMessage, Gateway, timezone_validator, CostEntryData
+from openmodule.models.base import OpenModuleModel, ZMQMessage, Gateway, timezone_validator
 
 
 class TestModel(OpenModuleModel):
@@ -138,11 +136,3 @@ class ZMQMessageTestCase(TestCase):
 
         res1.pop("timestamp")
         self.assertDictEqual(res1, {"name": "tä\nst", "type": "tö\tst"})
-
-
-class CostEntryDataTextCase(TestCase):
-    def test_type_parsing(self):
-        res = CostEntryData.parse_raw(b'{"entry_type": "static_cost", "value": 10, "account_id": "0"}')
-        self.assertTrue(isinstance(res.value, int))
-        res = CostEntryData.parse_raw(b'{"entry_type": "rate_change", "value": "10", "account_id": "0"}')
-        self.assertTrue(isinstance(res.value, str))

{openmodule-14.2.0rc0 → openmodule-14.3.0}/tests/test_utils_signal.py

@@ -1,7 +1,9 @@
-from openmodule.models.signal import SignalMessage, SignalType, TriggerSignalsRequest, TriggerSignalsResponse
+from typing import Optional
+
+from openmodule.models.signals import SignalMessage, SignalType, TriggerSignalsRequest, TriggerSignalsResponse
 from openmodule.rpc import RPCClient
-from openmodule.utils.signal import (SignalListener, GetSignalValueRequest, GetSignalValueResponse, FilterType,
-                                     ChangeType, Signal)
+from openmodule.utils.signal_listener import (SignalListener, GetSignalValueRequest, GetSignalValueResponse, FilterType,
+                                              ChangeType, Signal)
 from openmodule_test.core import OpenModuleCoreTestMixin
 from openmodule_test.eventlistener import MockEvent
 from openmodule_test.rpc import MockRPCClient
@@ -186,7 +188,7 @@ class TestSignalListener(OpenModuleCoreTestMixin):
         self.assertEqual(True, signal_listener.get_value("false"))
 
     def test_trigger(self):
-        request = None
+        request: Optional[TriggerSignalsRequest] = None
         res = TriggerSignalsResponse(success=True)
         def trigger(req: TriggerSignalsRequest, _) -> bool:
             nonlocal request, res
@@ -227,4 +229,3 @@ class TestSignalListener(OpenModuleCoreTestMixin):
         with self.assertLogs() as log:
             self.assertEqual(False, signal_listener.trigger_signals())
         self.assertIn("Error while triggering signals.", str(log.output))
-

openmodule-14.2.0rc0/openmodule.egg-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "06249ea", "is_release": true}