Skip to content

Commit

Permalink
Chore/integ 1920 update risk severity filter (#389)
Browse files Browse the repository at this point in the history
* update sdk.queries.alerts.filters.alert_filter.Severity with new values, alias MEDIUM>MODERATE for backward compat

* update CHANGELOG

* correct docstring

* style

* update tests
  • Loading branch information
timabrmsn committed Dec 6, 2021
1 parent edaec7f commit b78a6b1
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 10 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
The intended audience of this file is for py42 consumers -- as such, changes that don't affect
how a consumer would use the library (e.g. adding unit tests, updating documentation, etc) are not captured here.

## Unreleased

### Changed

- Updated `sdk.queries.alerts.filters.alerts_filter.Severity` enum to use updated `riskSeverity` search propert instead of deprecated `severity`.
- New values `CRITICAL` and `MODERATE`.
- Aliased previous `severity.MEDIUM` > `riskSeverity.MODERATE` for backwards compatibility.

## 1.19.3 - 2021-11-09

### Removed
Expand Down
9 changes: 6 additions & 3 deletions src/py42/sdk/queries/alerts/filters/alert_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,15 +155,18 @@ class Severity(QueryFilterStringField, Choices):
"""Class that filters alerts based on severity.
Available options are:
- :attr:`Severity.CRITICAL`
- :attr:`Severity.HIGH`
- :attr:`Severity.MEDIUM`
- :attr:`Severity.MODERATE`
- :attr:`Severity.LOW`
"""

_term = "severity"
_term = "riskSeverity"

CRITICAL = "CRITICAL"
HIGH = "HIGH"
MEDIUM = "MEDIUM"
MEDIUM = "MODERATE"
MODERATE = "MODERATE"
LOW = "LOW"


Expand Down
14 changes: 7 additions & 7 deletions tests/sdk/queries/alerts/filters/test_alert_filter.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,27 +141,27 @@ def test_actor_not_contains_str_gives_correct_json_representation():

def test_severity_eq_str_gives_correct_json_representation():
_filter = Severity.eq("HIGH")
expected = IS.format("severity", "HIGH")
expected = IS.format("riskSeverity", "HIGH")
assert str(_filter) == expected


def test_severity_not_eq_str_gives_correct_json_representation():
_filter = Severity.not_eq("HIGH")
expected = IS_NOT.format("severity", "HIGH")
expected = IS_NOT.format("riskSeverity", "HIGH")
assert str(_filter) == expected


def test_severity_is_in_str_gives_correct_json_representation():
items = ["HIGH", "MEDIUM", "LOW"]
items = ["HIGH", "MODERATE", "LOW"]
_filter = Severity.is_in(items)
expected = IS_IN.format("severity", *sorted(items))
expected = IS_IN.format("riskSeverity", *sorted(items))
assert str(_filter) == expected


def test_severity_not_in_str_gives_correct_json_representation():
items = ["HIGH", "MEDIUM", "LOW"]
items = ["HIGH", "MODERATE", "LOW"]
_filter = Severity.not_in(items)
expected = NOT_IN.format("severity", *sorted(items))
expected = NOT_IN.format("riskSeverity", *sorted(items))
assert str(_filter) == expected


Expand Down Expand Up @@ -363,7 +363,7 @@ def test_rule_type_choices_returns_set():

def test_severity_choices_returns_set():
choices = Severity.choices()
valid_set = {"HIGH", "MEDIUM", "LOW"}
valid_set = {"CRITICAL", "HIGH", "MODERATE", "LOW"}
assert set(choices) == valid_set


Expand Down

0 comments on commit b78a6b1

Please sign in to comment.