Skip to content

Commit

Permalink
Bugfix/alert max page size (#121)
Browse files Browse the repository at this point in the history
  • Loading branch information
alanag13 committed Jun 10, 2020
1 parent 9b93284 commit f26059c
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 14 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,16 @@ 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
## 1.4.0 - 2020-06-10

### Added

- `get_all_org_cold_storage_archives()` function to `ArchiveModule`, available at `sdk.archive.get_all_org_cold_storage_archives()`.
- `get_query()` function to `sdk.securitydata.savedsearches` to get query against a saved search id.

### Fixed

- `AlertQuery` now defaults to a `page_size` of 500. A change made to the backing api of `sdk.alerts.search()` was causing all requests made with the previous default (10000) to fail.


## 1.3.0 - 2020-06-02

Expand Down
2 changes: 1 addition & 1 deletion src/py42/__version__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# py42

__version__ = "1.3.0"
__version__ = "1.4.0"
1 change: 1 addition & 0 deletions src/py42/sdk/queries/alerts/alert_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ def __init__(self, *args, **kwargs):
super(AlertQuery, self).__init__(*args, **kwargs)
self.sort_key = u"CreatedAt"
self.page_number = 0
self.page_size = 500
self.sort_direction = u"desc"

def __str__(self):
Expand Down
2 changes: 1 addition & 1 deletion tests/clients/test_alerts.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def test_search_posts_expected_data(self, mock_session, user_context, successful
and post_data["groupClause"] == "AND"
and post_data["srtKey"] == "CreatedAt"
and post_data["srtDirection"] == "desc"
and post_data["pgSize"] == 10000
and post_data["pgSize"] == 500
and post_data["pgNum"] == 0
and post_data["groups"][0]["filterClause"] == "AND"
and post_data["groups"][0]["filters"][0]["operator"] == "IS"
Expand Down
18 changes: 8 additions & 10 deletions tests/sdk/queries/alerts/test_alert_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@


def build_query_json(group_clause, group_list):
return JSON_QUERY_BASE.format(
_TENANT_ID, group_clause, group_list, 0, 10000, "desc", "CreatedAt"
)
return JSON_QUERY_BASE.format(_TENANT_ID, group_clause, group_list, 0, 500, "desc", "CreatedAt")


def test_alert_query_repr_does_not_throw_type_error():
Expand Down Expand Up @@ -101,16 +99,16 @@ def test_alert_query_str_with_page_num_gives_correct_json_representation(event_f
alert_query = AlertQuery(event_filter_group)
alert_query.page_number = 5
json_query_str = JSON_QUERY_BASE.format(
_TENANT_ID, "AND", event_filter_group, 5, 10000, "desc", "CreatedAt"
_TENANT_ID, "AND", event_filter_group, 5, 500, "desc", "CreatedAt"
)
assert str(alert_query) == json_query_str


def test_alert_query_str_with_page_size_gives_correct_json_representation(event_filter_group):
alert_query = AlertQuery(event_filter_group)
alert_query.page_size = 500
alert_query.page_size = 250
json_query_str = JSON_QUERY_BASE.format(
_TENANT_ID, "AND", event_filter_group, 0, 500, "desc", "CreatedAt"
_TENANT_ID, "AND", event_filter_group, 0, 250, "desc", "CreatedAt"
)
assert str(alert_query) == json_query_str

Expand All @@ -119,7 +117,7 @@ def test_alert_query_str_with_sort_direction_gives_correct_json_representation(e
alert_query = AlertQuery(event_filter_group)
alert_query.sort_direction = "asc"
json_query_str = JSON_QUERY_BASE.format(
_TENANT_ID, "AND", event_filter_group, 0, 10000, "asc", "CreatedAt"
_TENANT_ID, "AND", event_filter_group, 0, 500, "asc", "CreatedAt"
)
assert str(alert_query) == json_query_str

Expand All @@ -128,7 +126,7 @@ def test_alert_query_str_with_sort_key_gives_correct_json_representation(event_f
alert_query = AlertQuery(event_filter_group)
alert_query.sort_key = "some_field_to_sort_by"
json_query_str = JSON_QUERY_BASE.format(
_TENANT_ID, "AND", event_filter_group, 0, 10000, "desc", "some_field_to_sort_by"
_TENANT_ID, "AND", event_filter_group, 0, 500, "desc", "some_field_to_sort_by"
)
assert str(alert_query) == json_query_str

Expand All @@ -142,7 +140,7 @@ def test_alert_query_from_dict_gives_correct_json_representation():
alert_query_dict = {"groupClause": "AND", "groups": [group]}
alert_query = AlertQuery.from_dict(alert_query_dict)
json_query_str = JSON_QUERY_BASE.format(
_TENANT_ID, "AND", group_str, 0, 10000, "desc", "CreatedAt"
_TENANT_ID, "AND", group_str, 0, 500, "desc", "CreatedAt"
)
assert str(alert_query) == json_query_str

Expand All @@ -152,7 +150,7 @@ def test_alert_query_dict_gives_expected_dict_representation(event_filter_group)
alert_query_query_dict = dict(alert_query)
assert alert_query_query_dict["groupClause"] == "AND"
assert alert_query_query_dict["pgNum"] == 0
assert alert_query_query_dict["pgSize"] == 10000
assert alert_query_query_dict["pgSize"] == 500
assert alert_query_query_dict["srtDirection"] == "desc"
assert alert_query_query_dict["srtKey"] == "CreatedAt"
assert type(alert_query_query_dict["groups"]) == list
Expand Down

0 comments on commit f26059c

Please sign in to comment.