cactus-test-definitions 1.2.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

cactus_test_definitions/__init__.py

@@ -18,7 +18,7 @@ from cactus_test_definitions.variable_expressions import (
     try_extract_variable_expression,
 )
 
-__version__ = "1.2.0"
+__version__ = "1.3.0"
 
 __all__ = [
     "TestProcedureDefinitionError",

cactus_test_definitions/client/checks.py

@@ -33,6 +33,16 @@ class Check:
                 self.parameters[k] = parse_variable_expression_body(variable_expr, k)
 
 
+def factory_readings_schema() -> dict[str, Any]:
+    """Factory function for common schema shared across reading checks."""
+    return {
+        "minimum_count": ParameterSchema(False, ParameterType.Integer),
+        "minimum_level": ParameterSchema(False, ParameterType.Float),
+        "maximum_level": ParameterSchema(False, ParameterType.Float),
+        "window_seconds": ParameterSchema(False, ParameterType.UnsignedInteger),
+    }
+
+
 # The parameter schema for each action, keyed by the action name
 CHECK_PARAMETER_SCHEMA: dict[str, dict[str, ParameterSchema]] = {
     "all-steps-complete": {"ignored_steps": ParameterSchema(False, ParameterType.ListString)},
@@ -88,12 +98,12 @@ CHECK_PARAMETER_SCHEMA: dict[str, dict[str, ParameterSchema]] = {
         "operationalModeStatus": ParameterSchema(False, ParameterType.Integer),
         "alarmStatus": ParameterSchema(False, ParameterType.Integer),
     },
-    "readings-voltage": {"minimum_count": ParameterSchema(True, ParameterType.Integer)},
-    "readings-site-active-power": {"minimum_count": ParameterSchema(True, ParameterType.Integer)},
-    "readings-site-reactive-power": {"minimum_count": ParameterSchema(True, ParameterType.Integer)},
-    "readings-der-active-power": {"minimum_count": ParameterSchema(True, ParameterType.Integer)},
-    "readings-der-reactive-power": {"minimum_count": ParameterSchema(True, ParameterType.Integer)},
-    "readings-der-stored-energy": {"minimum_count": ParameterSchema(True, ParameterType.Integer)},  # Storage extension
+    "readings-voltage": factory_readings_schema(),
+    "readings-site-active-power": factory_readings_schema(),
+    "readings-site-reactive-power": factory_readings_schema(),
+    "readings-der-active-power": factory_readings_schema(),
+    "readings-der-reactive-power": factory_readings_schema(),
+    "readings-der-stored-energy": factory_readings_schema(),
     "subscription-contents": {"subscribed_resource": ParameterSchema(True, ParameterType.String)},
     "response-contents": {
         "latest": ParameterSchema(False, ParameterType.Boolean),

cactus_test_definitions/parameters.py

@@ -30,6 +30,7 @@ class ParameterType(IntEnum):
     ListCSIPAusReadingType = auto()  # List where each member is a cactus_test_definitions.csipaus.CSIPAusReadingType
     CSIPAusReadingLocation = auto()  # Member of cactus_test_definitions.csipaus.CSIPAusReadingLocation
     ReadingTypeValues = auto()  # A dict of type dict[CSIPAusReadingType, list[float]], each list has the same length
+    UnsignedInteger = auto()
 
 
 @dataclass(frozen=True)
@@ -61,6 +62,9 @@ def is_valid_parameter_type(expected_type: ParameterType, value: Any) -> bool:
                     return int(value) == value
                 except Exception:
                     return False
+        case ParameterType.UnsignedInteger:
+            # Integer that is greater than or equal to 0
+            return is_valid_parameter_type(ParameterType.Integer, value) and value >= 0
         case ParameterType.Float:
             return isinstance(value, float) or isinstance(value, Decimal) or isinstance(value, int)
         case ParameterType.Boolean:

{cactus_test_definitions-1.2.0.dist-info → cactus_test_definitions-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cactus-test-definitions
-Version: 1.2.0
+Version: 1.3.0
 Summary: CSIP-AUS Client Test Harness Test Definitions
 Author-email: Mike Turner <mike.turner@anu.edu.au>, Josh Vote <joshua.vote@anu.edu.au>
 Maintainer-email: Mike Turner <mike.turner@anu.edu.au>, Josh Vote <joshua.vote@anu.edu.au>
@@ -203,11 +203,11 @@ checks:
 | `der-settings-contents` | `setGradW: int/None` `doeModesEnabled_set: hex/none` `doeModesEnabled_unset: hex/none` `doeModesEnabled: bool/none` `modesEnabled_set: hex/none` `modesEnabled_unset: hex/none` `setMaxVA: bool/none` `setMaxVar: bool/none` `setMaxW: bool/none` `setMaxChargeRateW: bool/none` `setMaxDischargeRateW: bool/none` `setMaxWh: bool/none` `setMinWh: bool/none` `vppModesEnabled_set: hexbinary/none` `vppModesEnabled_unset: hexbinary/none` `setMaxVarNeg: bool/none` `setMinPFOverExcited: bool/none` `setMinPFUnderExcited: bool/none` | True if a `DERSettings` has been set for the `EndDevice` under test (and if certain elements have been set to certain values) |
 | `der-capability-contents` | `doeModesSupported_set: hex/none` `doeModesSupported_unset: hex/none` `doeModesSupported: bool/none` `modesSupported_set: hex/none` `modesSupported_unset: hex/none` `rtgMaxVA: bool/none` `rtgMaxVar: bool/none` `rtgMaxW: bool/none` `rtgMaxChargeRateW: bool/none` `rtgMaxDischargeRateW: bool/none` `rtgMaxWh: bool/none` `vppModesSupported_set: hexbinary/none` `vppModesSupported_unset: hexbinary/none` `rtgMaxVarNeg: bool/none` `rtgMinPFOverExcited: bool/none` `rtgMinPFUnderExcited: bool/none` | True if a `DERCapability` has been set for the `EndDevice` under test (and if certain elements have been set to certain values) |
 | `der-status-contents` | `genConnectStatus: int/None` `operationalModeStatus: int/None` `alarmStatus: int/None` | True if a `DERStatus` has been set for the `EndDevice` under test (and if certain elements have been set to certain values) |
-| `readings-site-active-power` | `minimum_count: int` | True if any MirrorUsagePoint has a MirrorMeterReading for site wide active power with `minimum_count` entries |
-| `readings-site-reactive-power` | `minimum_count: int` | True if any MirrorUsagePoint has a MirrorMeterReading for site wide reactive power with `minimum_count` entries |
-| `readings-voltage` | `minimum_count: int` | True if any MirrorUsagePoint has a MirrorMeterReading for site wide voltage OR DER voltage with `minimum_count` entries (at least one is required) |
-| `readings-der-active-power` | `minimum_count: int` | True if any MirrorUsagePoint has a MirrorMeterReading for DER active power with `minimum_count` entries |
-| `readings-der-reactive-power` | `minimum_count: int` | True if any MirrorUsagePoint has a MirrorMeterReading for DER reactive power with `minimum_count` entries |
+| `readings-site-active-power` | `minimum_count: int/none` `minimum_level: float/none` `maximum_level: float/none` `window_seconds: uint/none` | True if any MirrorUsagePoint has a MirrorMeterReading for site wide active power with `minimum_count` entries and/or readings all above and/or below `minimum_level`/`maximum_level` respectively; optionally for `window_seconds` |
+| `readings-site-reactive-power` | `minimum_count: int/none` `minimum_level: float/none` `maximum_level: float/none` `window_seconds: uint/none` | True if any MirrorUsagePoint has a MirrorMeterReading for site wide reactive power with `minimum_count` entries and/or readings all above and/or below `minimum_level`/`maximum_level` respectively; optionally for `window_seconds` |
+| `readings-voltage` | `minimum_count: int/none` `minimum_level: float/none` `maximum_level: float/none` `window_seconds: uint/none` | True if any MirrorUsagePoint has a MirrorMeterReading for site wide voltage OR DER voltage with `minimum_count` entries (at least one is required) |
+| `readings-der-active-power` | `minimum_count: int/none` `minimum_level: float/none` `maximum_level: float/none` `window_seconds: uint/none` | True if any MirrorUsagePoint has a MirrorMeterReading for DER active power with `minimum_count` entries and/or readings all above and/or below `minimum_level`/`maximum_level` respectively; optionally for `window_seconds` |
+| `readings-der-reactive-power` | `minimum_count: int/none` `minimum_level: float/none` `maximum_level: float/none` `window_seconds: uint/none` | True if any MirrorUsagePoint has a MirrorMeterReading for DER reactive power with `minimum_count` entries and/or readings all above and/or below `minimum_level`/`maximum_level` respectively; optionally for `window_seconds` |
 | `response-contents` | `latest: bool/None` `status: int/None` `all: bool/None` | True if at least one received Response matches the filter. `latest` will only consider the most recent received Response. `all` will look for a nominated status match for every `DERControl` |
 | `subscription-contents` | `subscribed_resource: str` | True if a subscription to `subscribed_resource` has been created | 
 
@@ -215,7 +215,7 @@ The following are csipaus.org/ns/v1.3-beta/storage extension specific checks imp
 
 | **name** | **params** | **description** |
 | -------- | ---------- | --------------- |
-| `readings-der-stored-energy` | `minimum_count: int` | True if any MirrorUsagePoint has a MirrorMeterReading for DER stored energy with `minimum_count` entries |
+| `readings-der-stored-energy` | `minimum_count: int/none` `minimum_level: float/none` `maximum_level: float/none` `window_seconds: uint/none` | True if any MirrorUsagePoint has a MirrorMeterReading for DER stored energy with `minimum_count` entries and/or readings all above and/or below `minimum_level`/`maximum_level` respectively; optionally for `window_seconds` |
 <br>
 
 #### Hexbinary Parameters for Bitwise Operations

{cactus_test_definitions-1.2.0.dist-info → cactus_test_definitions-1.3.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-cactus_test_definitions/__init__.py,sha256=PUvdJH3ZVqVLdZL3Xyal76YRHmEg8b4HnVdTaQxChFw,987
+cactus_test_definitions/__init__.py,sha256=POQ9DrRzKNT3K4_tjdoTC1vmx7O1bIhR4jlkAEqYOpo,987
 cactus_test_definitions/csipaus.py,sha256=HhBM6scS-Hlz8hFoGct7D2cJOK8NCN6f3CDP72gv7Dk,2864
 cactus_test_definitions/errors.py,sha256=_ZKl42SaEF5c2s9YySJUjGqVCBXSQYOLxpHQhSbNFug,458
-cactus_test_definitions/parameters.py,sha256=y2pCrE6MADXA53ZVZeNWj0_yWHcKOZ2imzjh_pZDorQ,6509
+cactus_test_definitions/parameters.py,sha256=FcWvB2UX2MVLYUY8mzGzbFfro3jyLQuoHXzrfoblnic,6727
 cactus_test_definitions/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cactus_test_definitions/schema.py,sha256=XYMlr2l_pfbyuwXLO88YryjObvxDVEV5IZ2hsThdy2k,736
 cactus_test_definitions/variable_expressions.py,sha256=6oVRj-6lXVKt6zIpSmXpzD2A8ayOWZ2eEpO5_uR6OdE,16741
@@ -19,7 +19,7 @@ cactus_test_definitions/__pycache__/variable_expressions.cpython-312.pyc,sha256=
 cactus_test_definitions/__pycache__/version.cpython-312.pyc,sha256=MYqjwvU2QmzT5lHqXLMdvVg1hQ9eN0gLQnluRgpLn0M,624
 cactus_test_definitions/client/__init__.py,sha256=M5rZLtoAKOgtzgC51KlB_iVhS3mo1ujMjJg5cnD4Z3w,692
 cactus_test_definitions/client/actions.py,sha256=tJNNVmK_itcXPgHxewBZvUsw3u0WK67S5zliULGForI,4924
-cactus_test_definitions/client/checks.py,sha256=8MEfG5YDVPFXrIySf_e2ePnLUHqdd3Odq7LmIIFGeDI,7415
+cactus_test_definitions/client/checks.py,sha256=yrRiKxCVDZeZi4MkhHOrhqff-YjlAwCA7d7qqM04Dno,7604
 cactus_test_definitions/client/events.py,sha256=Skt7rovadrpVqY7nUpxP0MGG_-1wWlD28JPKhZX-z8E,3098
 cactus_test_definitions/client/test_procedures.py,sha256=7ZUlBXf6r6DHVakJpLseYaG_mpbjyqFFE0SwYOcU0UU,11059
 cactus_test_definitions/client/__pycache__/__init__.cpython-312.pyc,sha256=nk72E-Cj_QWolW48s8S_mHerqAhMnb4f8CT0_QSvUqA,785
@@ -115,7 +115,7 @@ cactus_test_definitions/server/procedures/S-OPT-02.yaml,sha256=jMoMRo_vgfaB9yoY9
 cactus_test_definitions/server/procedures/S-OPT-03.yaml,sha256=tOzDTOE9D-CWT61RuWRTDGcpt7W57NcH9_eZvQyLhFs,980
 cactus_test_definitions/server/procedures/S-OPT-04.yaml,sha256=o33HNLTzxQm__KbFW1x2ce04uW-xx6Li0aijJI_XbYQ,667
 cactus_test_definitions/server/procedures/test-procedures.yaml,sha256=3GqHgROh3YvenXB3RH9lg05809IqAtp_uohT_hUdyIE,395
-cactus_test_definitions-1.2.0.dist-info/licenses/LICENSE.txt,sha256=xCq-ofiZHRqQJHkhY1M-eXahPozfXmo9qvez6BiCOdk,1074
+cactus_test_definitions-1.3.0.dist-info/licenses/LICENSE.txt,sha256=xCq-ofiZHRqQJHkhY1M-eXahPozfXmo9qvez6BiCOdk,1074
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit/test_csipaus.py,sha256=edFnWDlHgMuW7CK9l8z-FHA1GcIACVJ1RPERiFuWfcY,1959
@@ -123,13 +123,13 @@ tests/unit/test_parameters.py,sha256=FqkJtC2Tct9hbuznzzsNyomvmZ24Q3RS2B_tfK0-T5M
 tests/unit/test_variable_expressions.py,sha256=HTeEcLiJPmMREJs4mOfR0Q48l8E-XYyQgISn5XLW2BU,15969
 tests/unit/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit/client/test_actions.py,sha256=pIVprTLPpD4mGkmORArIEKuoFShzWleakqEZHDGV4rQ,3172
-tests/unit/client/test_checks.py,sha256=PPQDnoZU02-nXcWaXBfm09hG9DUx7O6ZCPVbshazy78,2419
+tests/unit/client/test_checks.py,sha256=Al91dwToyn_1LGjb2dVLNjHAOcGfXwK_GTr0dVOzKsI,3417
 tests/unit/client/test_config.py,sha256=0Jdgd6DsZuq35OQDUP-l9H9QlQuNaaqDXWV_r7ssLto,2454
 tests/unit/client/test_events.py,sha256=bXDW0Ykx9hqh8MLv1b_9a942LahlhE3L2pu7NyGsdRo,1550
 tests/unit/client/test_test_procedures.py,sha256=GKOQo007C4o4DbsCL4aJfpPqz108ueQ-zJUpwHu56Uw,6950
 tests/unit/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit/server/test_test_procedures.py,sha256=5yC3Npq6PrDqj4A3URcFd5-0cXmLooxWt51OXJ4Kd0U,3976
-cactus_test_definitions-1.2.0.dist-info/METADATA,sha256=9JXbXfXYhxZnrgqJicrBOjRQht7ZB2QxoqPz1hd5UO4,21248
-cactus_test_definitions-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cactus_test_definitions-1.2.0.dist-info/top_level.txt,sha256=4tQTXLPjTzH6OYZqOj40IX8XgosTUTUEJTESjtj0KfI,30
-cactus_test_definitions-1.2.0.dist-info/RECORD,,
+cactus_test_definitions-1.3.0.dist-info/METADATA,sha256=uM1ZFnnEHqnZp2X4UmB4vj6jdqemzFsiMqcBnn_xBF8,22367
+cactus_test_definitions-1.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cactus_test_definitions-1.3.0.dist-info/top_level.txt,sha256=4tQTXLPjTzH6OYZqOj40IX8XgosTUTUEJTESjtj0KfI,30
+cactus_test_definitions-1.3.0.dist-info/RECORD,,

tests/unit/client/test_checks.py

@@ -8,9 +8,33 @@ from cactus_test_definitions.errors import TestProcedureDefinitionError
     "check, is_valid",
     [
         (Check("foo", {}), False),  # Unknown check
-        (Check("readings-site-active-power", {}), False),
+        (Check("readings-site-active-power", {}), True),
         (Check("readings-site-active-power", {"minimum_count": "3"}), False),
         (Check("readings-site-active-power", {"minimum_count": 3}), True),
+        (Check("readings-site-active-power", {"minimum_count": 3, "minimum_level": 12.3}), True),
+        (Check("readings-site-active-power", {"minimum_count": 3, "maximum_level": 12.3}), True),
+        (Check("readings-site-active-power", {"minimum_count": 3, "minimum_level": 12.3, "maximum_level": 12.3}), True),
+        (
+            Check(
+                "readings-site-active-power",
+                {"minimum_count": 3, "minimum_level": 12.3, "maximum_level": 12.3, "window_seconds": 12.3},
+            ),
+            False,
+        ),
+        (
+            Check(
+                "readings-site-active-power",
+                {"minimum_count": 3, "minimum_level": 12.3, "maximum_level": 12.3, "window_seconds": 180},
+            ),
+            True,
+        ),
+        (
+            Check(
+                "readings-site-active-power",
+                {"minimum_count": 3, "minimum_level": 12.3, "maximum_level": 12.3, "window_seconds": -180},
+            ),
+            False,
+        ),
         (Check("der-settings-contents", {"setGradW": 27}), True),
         (Check("der-settings-contents", {"doeModesEnabled_set": "0f"}), True),
         (Check("der-settings-contents", {"doeModesEnabled_unset": "0f"}), True),