fluidattacks_core_models 13.1.0__tar.gz → 14.0.0__tar.gz

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/.gitignore

@@ -1,3 +1,4 @@
+dist/
 dist-*/
 /.cargo-cache
 target/
@@ -5,3 +6,4 @@ target/
 .venv/
 .vscode/settings.json
 .zed/settings.json
+*.so

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fluidattacks_core_models
-Version: 13.1.0
+Version: 14.0.0
 Summary: Fluid Attacks Core Models Library
 Author-email: Development <development@fluidattacks.com>
 License: MPL-2.0

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/fluidattacks_core/models/state_machines/__init__.py

@@ -1,6 +1,8 @@
 from fluidattacks_core.models.state_machines.component_orchestrator import (
     ComponentScanOptions,
+    ResolvesScanOptions,
     StateMachineComponentOrchestrator,
+    TracesScanOptions,
 )
 from fluidattacks_core.models.state_machines.root_scanner import (
     ContextualizesScanInput,
@@ -8,8 +10,6 @@ from fluidattacks_core.models.state_machines.root_scanner import (
     PerRootScanOptions,
     StateMachineExecutePerRootInput,
     TJobNameSegment,
-    TracesScanInput,
-    TracesScanOptions,
     TStorageKey,
 )
 from fluidattacks_core.models.state_machines.types import (
@@ -26,6 +26,7 @@ __all__ = [
     "ContextualizesScanInput",
     "ContextualizesScanOptions",
     "PerRootScanOptions",
+    "ResolvesScanOptions",
     "StateMachine",
     "StateMachineCloningInput",
     "StateMachineComponentOrchestrator",
@@ -36,6 +37,5 @@ __all__ = [
     "TCloningTrigger",
     "TJobNameSegment",
     "TStorageKey",
-    "TracesScanInput",
     "TracesScanOptions",
 ]

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/fluidattacks_core/models/state_machines/component_orchestrator.py

@@ -20,6 +20,14 @@ class ComponentScanOptions(BaseModel):
     user_email: TVisibleAscii = Field(..., min_length=1)
 
 
+class ResolvesScanOptions(ComponentScanOptions):
+    pass
+
+
+class TracesScanOptions(ComponentScanOptions):
+    group_name: TStorageKey
+
+
 TComponentOptions = TypeVar("TComponentOptions", bound=ComponentScanOptions)
 
 

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/fluidattacks_core/models/state_machines/root_scanner.py

@@ -44,10 +44,6 @@ class ContextualizesScanOptions(PerRootScanOptions):
     pass
 
 
-class TracesScanOptions(PerRootScanOptions):
-    pass
-
-
 TOptions = TypeVar("TOptions", bound=PerRootScanOptions)
 
 
@@ -98,7 +94,3 @@ class StateMachineExecutePerRootInput(BaseModel, Generic[TOptions]):
 
 class ContextualizesScanInput(StateMachineExecutePerRootInput[ContextualizesScanOptions]):
     pass
-
-
-class TracesScanInput(StateMachineExecutePerRootInput[TracesScanOptions]):
-    pass

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fluidattacks_core_models"
-version = "13.1.0"
+version = "14.0.0"
 description = "Fluid Attacks Core Models Library"
 authors = [{ name = "Development", email = "development@fluidattacks.com" }]
 license = { text = "MPL-2.0" }

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/tests/test_component_orchestrator.py

@@ -5,7 +5,9 @@ from pydantic import ValidationError
 
 from fluidattacks_core.models.state_machines.component_orchestrator import (
     ComponentScanOptions,
+    ResolvesScanOptions,
     StateMachineComponentOrchestrator,
+    TracesScanOptions,
 )
 from fluidattacks_core.models.state_machines.root_scanner import (
     MACHINE_NAME_DIGEST_LENGTH,
@@ -14,7 +16,7 @@ from fluidattacks_core.models.state_machines.root_scanner import (
 )
 
 
-class _ResolvesScanOptions(ComponentScanOptions):
+class _OptionsWithAnExtraField(ComponentScanOptions):
     seed_domain: str
 
 
@@ -155,15 +157,51 @@ def test_machine_name_is_injective() -> None:
 
 
 def test_orchestrator_binds_the_options_type_it_is_parameterized_with() -> None:
-    resolves = _ResolvesScanOptions(
+    extended = _OptionsWithAnExtraField(
         config_id="123456",
         entity_name="acme",
         seed_domain="acme.com",
         user_email="test@fluidattacks.com",
     )
-    machine_input = StateMachineComponentOrchestrator[_ResolvesScanOptions].model_validate(
-        _wire_payload(options=resolves)
+    machine_input = StateMachineComponentOrchestrator[_OptionsWithAnExtraField].model_validate(
+        _wire_payload(options=extended)
     )
     assert json.loads(machine_input.execution_options)["seed_domain"] == "acme.com"
     with pytest.raises(ValidationError):
-        StateMachineComponentOrchestrator[_ResolvesScanOptions].model_validate(_wire_payload())
+        StateMachineComponentOrchestrator[_OptionsWithAnExtraField].model_validate(_wire_payload())
+
+
+def test_resolves_options_add_no_fields_of_their_own() -> None:
+    options = ResolvesScanOptions(
+        config_id="123456", entity_name="acme", user_email="test@fluidattacks.com"
+    )
+    with pytest.raises(ValidationError):
+        ResolvesScanOptions.model_validate({**options.model_dump(), "seed_domain": "acme.com"})
+
+
+def _traces_options(**overrides: str) -> TracesScanOptions:
+    arguments: dict[str, str] = {
+        "config_id": "123456",
+        "entity_name": "nickname",
+        "group_name": "acme",
+        "user_email": "test@fluidattacks.com",
+    }
+    arguments.update(overrides)
+    return TracesScanOptions(**arguments)
+
+
+def test_traces_options_declare_the_group_the_orchestrator_does_not_carry() -> None:
+    options = _traces_options()
+    assert set(options.model_dump()) == set(ComponentScanOptions.model_fields) | {"group_name"}
+    with pytest.raises(ValidationError):
+        TracesScanOptions.model_validate(_options().model_dump())
+
+
+def test_traces_group_name_is_a_storage_key_and_reaches_the_scanner_on_the_wire() -> None:
+    for value in ("a/b", "..", "acme corp", "_leading", ""):
+        with pytest.raises(ValidationError):
+            _traces_options(group_name=value)
+    machine_input = StateMachineComponentOrchestrator[TracesScanOptions].model_validate(
+        _wire_payload(options=_traces_options(), scanner_name="traces-scan")
+    )
+    assert json.loads(machine_input.execution_options)["group_name"] == "acme"

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/tests/test_root_scanner.py

@@ -11,8 +11,6 @@ from fluidattacks_core.models.state_machines.root_scanner import (
     ContextualizesScanOptions,
     PerRootScanOptions,
     StateMachineExecutePerRootInput,
-    TracesScanInput,
-    TracesScanOptions,
 )
 
 
@@ -267,44 +265,3 @@ def test_execute_per_root_machine_name_is_injective() -> None:
     assert len(names) == 2
     assert len(masked) == 2
     assert len(roots) == 2
-
-
-def _traces_options(**overrides: str) -> TracesScanOptions:
-    arguments: dict[str, str] = {
-        "config_id": "123456",
-        "group_name": "acme",
-        "root_nickname": "nickname",
-        "user_email": "test@fluidattacks.com",
-    }
-    arguments.update(overrides)
-    return TracesScanOptions(**arguments)
-
-
-def _traces_input(options: TracesScanOptions | None = None) -> TracesScanInput:
-    return TracesScanInput.model_validate(
-        {
-            "job_definition": "traces_run",
-            "job_queue": "traces",
-            "scanner_name": "traces-scan-run",
-            "options": options if options is not None else _traces_options(),
-        }
-    )
-
-
-def test_traces_scan_options_are_exactly_the_shared_per_root_fields() -> None:
-    options = _traces_options()
-    assert set(options.model_dump()) == set(PerRootScanOptions.model_fields)
-    assert TracesScanOptions.model_validate_json(options.model_dump_json()) == options
-
-
-def test_traces_scan_input_keeps_the_seven_wire_keys_the_machine_reads() -> None:
-    dumped = _traces_input().to_wire()
-    assert set(dumped) == {
-        "configId",
-        "executionOptions",
-        "groupName",
-        "jobDefinition",
-        "jobQueue",
-        "rootNickname",
-        "scannerName",
-    }

{fluidattacks_core_models-13.1.0 → fluidattacks_core_models-14.0.0}/uv.lock

@@ -187,7 +187,7 @@ wheels = [
 
 [[package]]
 name = "fluidattacks-core-models"
-version = "13.1.0"
+version = "14.0.0"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },