Sergey Polzunov
1fb60d6475
* first pass * Adding a dedicated code checking workflow * Type fixes * linting config and python version bump * Type hints * Drop incorrect config option * More fixes * Style fixes * CI adjustments * Pyproject fixes * CI & pyproject fixes * Proper version bump * Tests formatting * Resolve cirtular dependency * Test fixes * Make sure the tests are formatted correctly * Check tweaks * Bumping python version in CI images * Pin marshmallow do 3.x because 4.x is not supported * License fix * Convert path to str * Making myself a codeowner * Missing kwargs param * Adding a missing kwargs to `set_score` * Update .github/CODEOWNERS Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com> * Dropping unnecessary raise * Dropping skipped test * Drop unnecessary var * Drop unused commented-out func * Disable typehinting for the whole func * Update linting command * Invalid type hist on the input param * Incorrect field type * Incorrect value used fix * Stricter values check * Simpler function call * Type condition fix * TOML formatter fix * Simpligy output conditions * Formatting * Use proper types instead of aliases * MITRE attack fixes * Using pathlib.Path for an argument * Use proper method to update a set from a dict * First round of `ruff` fixes * More fixes * More fixes * Hack against cyclic dependency * Ignore `PLC0415` * Remove unused markers * Cleanup * Fixing the incorrect condition * Update .github/CODEOWNERS Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com> * Set explicit default values for optional fields * Update the guidelines * Adding None Defaults --------- Co-authored-by: Mika Ayenson, PhD <Mikaayenson@users.noreply.github.com> Co-authored-by: eric-forte-elastic <eric.forte@elastic.co>
72 lines
1.8 KiB
Python
72 lines
1.8 KiB
Python
# Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
# or more contributor license agreements. Licensed under the Elastic License
|
|
# 2.0; you may not use this file except in compliance with the Elastic License
|
|
# 2.0.
|
|
|
|
"""Dataclasses for Action."""
|
|
|
|
from dataclasses import dataclass
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
from .mixins import MarshmallowDataclassMixin
|
|
from .schemas import definitions
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class ActionMeta(MarshmallowDataclassMixin):
|
|
"""Data stored in an exception's [metadata] section of TOML."""
|
|
|
|
creation_date: definitions.Date
|
|
rule_id: list[definitions.UUIDString]
|
|
rule_name: str
|
|
updated_date: definitions.Date
|
|
|
|
# Optional fields
|
|
deprecation_date: definitions.Date | None = None
|
|
comments: str | None = None
|
|
maturity: definitions.Maturity | None = None
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class Action(MarshmallowDataclassMixin):
|
|
"""Data object for rule Action."""
|
|
|
|
@dataclass
|
|
class ActionParams:
|
|
"""Data object for rule Action params."""
|
|
|
|
body: str
|
|
|
|
action_type_id: definitions.ActionTypeId
|
|
group: str
|
|
params: ActionParams
|
|
|
|
id: str | None = None
|
|
frequency: dict[str, Any] | None = None
|
|
alerts_filter: dict[str, Any] | None = None
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class TOMLActionContents(MarshmallowDataclassMixin):
|
|
"""Object for action from TOML file."""
|
|
|
|
metadata: ActionMeta
|
|
actions: list[Action]
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class TOMLAction:
|
|
"""Object for action from TOML file."""
|
|
|
|
contents: TOMLActionContents
|
|
path: Path
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
return self.contents.metadata.rule_name
|
|
|
|
@property
|
|
def id(self) -> list[definitions.UUIDString]:
|
|
return self.contents.metadata.rule_id
|