Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions pyoaev/apis/inject_expectation/model/expectation.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
from enum import Enum
from typing import List
from typing import Any, List
from uuid import UUID

from pydantic import BaseModel
from pydantic import BaseModel, Field, field_validator
from thefuzz import fuzz

from pyoaev.signatures.signature_type import SignatureType
Expand Down Expand Up @@ -41,11 +41,21 @@ class Expectation(BaseModel):
"""

inject_expectation_id: UUID
inject_expectation_signatures: List[ExpectationSignature]
inject_expectation_signatures: List[ExpectationSignature] = Field(
default_factory=list
)

success_label: str = "Success"
failure_label: str = "Failure"

@field_validator("inject_expectation_signatures", mode="before")
@classmethod
def _coerce_none_signatures_to_empty(cls, value: Any) -> Any:
# The platform serializes this field as null when an expectation has no
# signatures yet. Without this, a single such expectation raises a
# ValidationError that aborts the whole batch fetch (collectors#490).
return [] if value is None else value

def __init__(self, *a, **kw):
super().__init__(*a, **kw)
self.__api_client = kw["api_client"]
Expand Down
37 changes: 37 additions & 0 deletions test/apis/expectation/test_expectation.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,43 @@ def test_when_relevant_signatures_when_some_alert_data_dont_match_return_false(

self.assertFalse(matched)

def test_when_signatures_is_none_it_is_coerced_to_empty_list(self):
# The platform may serialize inject_expectation_signatures as null; parsing
# must not raise, otherwise a single such expectation aborts the whole
# batch fetch (collectors#490).
for model_cls in (DetectionExpectation, PreventionExpectation):
model = model_cls(
**{
"inject_expectation_id": uuid4(),
"inject_expectation_signatures": None,
},
api_client=create_mock_api_client(),
)
self.assertEqual(model.inject_expectation_signatures, [])

def test_when_signatures_is_missing_it_defaults_to_empty_list(self):
model = DetectionExpectation(
**{"inject_expectation_id": uuid4()},
api_client=create_mock_api_client(),
)
self.assertEqual(model.inject_expectation_signatures, [])

def test_when_signatures_provided_they_are_preserved(self):
model = DetectionExpectation(
**{
"inject_expectation_id": uuid4(),
"inject_expectation_signatures": [
{
"type": SignatureTypes.SIG_TYPE_PARENT_PROCESS_NAME,
"value": "parent.exe",
},
],
},
api_client=create_mock_api_client(),
)
self.assertEqual(len(model.inject_expectation_signatures), 1)
self.assertEqual(model.inject_expectation_signatures[0].value, "parent.exe")


if __name__ == "__main__":
unittest.main()
Loading