Add missing __len__() implementation for IterableQueryMixin to fix len() on Alert query#242
Merged
Merged
Conversation
abowersox-cb
approved these changes
Jul 13, 2020
Contributor
abowersox-cb
left a comment
There was a problem hiding this comment.
This one's straightforward.
llyon-cb
approved these changes
Jul 13, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull request checklist
Please check if your PR fulfills the following requirements:
Pull request type
Please check the type of change your PR introduces:
What is the ticket or issue number?
Pull Request Description
Requesting the length of a
BaseAlertquery always returns 0. This is because the_count()function inBaseAlertSearchQueryis never called.__len__()in theIterableQueryMixinclass it inherits from is not implemented and always returns a length of 0, causing this behavior.This PR provides a fix by updating the
__len__()function inIterableQueryMixinto call the_count()function. It also initializesself._count_validandself._total_resultsinBaseAlertSearchQuerywith default values (asself._count_validis checked by_count()prior to making an API call for an initial count).Looking at the implementation for
_count()and__len__()forQueryincbapi/psc/threathunter/query.pyandPaginatedQueryincbapi/query.pythe default values there are set in thePaginatedQueryclass. For this fix I've initialized the variables inBaseAlertSearchQueryinstead and not theIterableQueryMixinclass it inherits from. If this needs to be changed (i.e. initialization moved toIterableQueryMixin), please let me know.Does this introduce a breaking change?
How Has This Been Tested?
The following script has been used to test this PR:
Which results in the following output: