aboutsummaryrefslogtreecommitdiffstats
path: root/tests/helpers.py (unfollow)
Commit message (Collapse)AuthorLines
2020-05-11Add a test helper function to patch multiple attributes with autospecsGravatar MarkKoz-0/+9
This helper reduces redundancy/boilerplate by setting default values. It also has the consequence of shortening the length of the invocation, which makes it faster to use and easier to read.
2020-05-11Test on_message_edit of token remover uses on_messageGravatar MarkKoz-2/+10
2020-05-11Token remover: reduce duplicated code in `on_message_edit`Gravatar MarkKoz-3/+1
2020-05-11Token remover: catch ValueError when non-ASCII chars are presentGravatar MarkKoz-2/+2
The token uses base64 and base64 only allows ASCII characters. Thus, if a match has non-ASCII characters, it's not a valid token. Catching the ValueError is simpler than trying to adjust the regex to only match valid base64. Fixes #928 Fixes BOT-3X
2020-05-11Restructure `apply_ban()` logic Gravatar Daniel Brown-12/+7
Another refactor/cleaning to make the logic clearer and easier to understand. Also cleaned up the trace logs to be shorter and more concise. Thanks, @scragly! Co-authored-by: scragly <[email protected]>
2020-05-10Add remindme alias for the remind commandGravatar Suhail-1/+1
2020-05-07apply_ban() logic refinedGravatar Daniel Brown-15/+15
- Refined the logic for `apply_ban()` even further to be cleaner. (Thanks, @MarkKoz!) Signed-off-by: Daniel Brown <[email protected]>
2020-05-07Addressing Review ChangesGravatar Daniel Brown-25/+31
- Changed docstring explanation and function name of `get_active_infractions` to `get_active_infraction()` to better convey that only one infraction is returned. Also changed all relevant uses to reflect that change. - Added explanation of parameter `send_msg` to the doc strings of `pardon_infraction()` and `get_active_infraction()` - Adjusted placement of `log.trace()` in `pardon_infraction()` - Adjusted logic in `apply_ban()` to remove redundant check. - Adjusted logic in `apply_ban()` to be consistent with other checks. Signed-off-by: Daniel Brown <[email protected]>
2020-05-04Update antimalware to filter txt files in cases where messages were longer ↵Gravatar Savant-Dev-5/+5
than 2000 chars
2020-05-04Perma Bans now Overwrite Temp BansGravatar Daniel Brown-18/+55
- Changed `has_active_infraction` to `get_active_infractions` in order to add additional logic in `apply_ban`. - Added `send_msg` parameters to `pardon_infraction` and `get_active_infractions` so that multi-step checks and actions don't need to send additional messages unless told to do so. Signed-off-by: Daniel Brown <[email protected]>
2020-05-02Remove mention command constantsGravatar MarkKoz-10/+0
2020-05-01Remove the mention commandGravatar MarkKoz-46/+2
It was made obsolete by a new Discord feature. Users can be granted a permission to mention a role despite the role being set as non-mentionable.
2020-05-01Update extension filter to distinguish .txt in cases where messages are ↵Gravatar Savant-Dev-1/+1
longer than 2000 characters
2020-05-01Update extension filter to distinguish .txt in cases where messages are ↵Gravatar Savant-Dev-0/+12
longer than 2000 characters
2020-04-30Tests: change avatar_url_as assertion to use static_formatGravatar MarkKoz-1/+1
2020-04-30Display animated avatars in the user info commandGravatar MarkKoz-1/+1
Fixes #914
2020-04-30Run a category check before logging that we are checking for an answered ↵Gravatar Joseph Banks-1/+2
help channel
2020-04-29Log unhandled errors from event listenersGravatar MarkKoz-0/+12
By default, discord.py prints them to stderr. To better help detect such errors in production, they should instead be logged with an appropriate log level. Some sentry metadata has also been included. `on_error` doesn't work as a listener in a cog so it's been put in the Bot subclass. Fixes #911
2020-04-28Log ID of member who claimed a help channelGravatar Sebastiaan Zeeff-0/+1
2020-04-28Add option to ingore channels in help categoriesGravatar Sebastiaan Zeeff-3/+14
As we want to add an "informational" channel to the `Python Help: Available` category, we need to make sure that the Help Channel System ignores that channel. To do that, I've added an `is_excluded_channel` staticmethod that returns `True` if a channel is not a TextChannel or if it's in a special EXCLUDED_CHANNELS constant. This method is then used in the method that yields help channels from a category and in the `on_message` event listener that determines if a channel should be moved from `Available` to `Occupied`.
2020-04-28Insert help channels at the bottom of the categoryGravatar Sebastiaan Zeeff-9/+48
This commit reintroduces bottom sorting for help channels during a category move, but in a more reliable way that also causes far fewer "channel list glitches". This is accomplished by using the "bulk channels update" endpoint of the Discord API. ----------- The Problem ----------- Discord's positioning system is not that easy to work with for developers: Instead of having separate pools of position integers for each category, all text channels are considered to be part of the same "position pool" (or "bucket" in discord.py terms). This also means that changing the position integer of one channel may cause the position integer of another to change, regardless of if the channels share a category or even of if they are close to each other in the guild. As clients receive the position update for each channel as separate CHANNEL UPDATE events, this means that moving one channel may cause other channels to (temporarily) jump around as the client receives the EVENTS from the API. As some position changes affect all the channels in the guild, this will also trigger a nice "channel wave" rolling down the channel list from time to time. For our use case, this was exacerbated by the way `discord.py` handles position changes: It will enumerate the entire, sorted channel list whenever a position change occurs and send a "bulk request" with updated position integers for the entire guild to Discord. This was the reason that all of the sorting methods we've tried resulted in a lot of those "wave" glitches as clients would get a lot of CHANNEL UPDATE events. In addition, the way `discord.py` inserted channels into the payload also meant that our "high integer" methods did not work reliably. ------------ The Solution ------------ Fortunately, there is a solution that will work well most of the time: Making a `bulk channels update` request with only channels of the category we're currently interested in. By providing the current position of the channels that are already in the category, combined with the correct position of the channel moving into the category, we effectively "lock in" the existing channels at the location they already have. The new channel is simply moved into the right position in relation to the existing channels. This means that effectively, we only communicate one channel position change to Discord, making sure that as few channels as possible actually change their formal "position int". From there on, there are two options: 1. Keep the existing channels in place, add the new channel at the bottom (new highest int) 2. Keep the existing channels in place, add the new channel at the top (new lowest int) Both methods work, but option two has a flaw: The position int will get smaller and smaller, until it reaches `0`. Since negative position integers are not allowed, the entire category now has to be shifted upwards to make room for new top channels. This comes at the cost of a "wave" glitch within the category. My initial instinct was to solve this by giving the channels in the category a "really high" straight of position ints, but as Discord recalculates the ints from time to time anyway, this does not work. That's why I opted for the `bottom sort` option, which does not suffer from that issue. I've also asked the question of `top` vs `bottom` in #admins, without the context above, and the preferred method seemed to be `bottom` in any case. ----------- Limitations ----------- While Discord doesn't care that much about duplicates or neatly ascending integers, some channel move actions will inevitably result in a recalculation of the positions ints. This means that "wave" glitches may still happen from time to time, but they should be infrequent. (They also happen if you drag channels in your client; it seems to be a fundamental part of how positioning works.) I think this is something we'll have to live with. Another thing that I suspect may happen is that during times of API lag in the middle of help channel rush hour, some CHANNEL UPDATE events belonging to previous channel moves will not be received/processed yet by the time we make the next move. As we rely on cached position integers, this could mean that from time to time a channel is inserted near the bottom but not at the bottom. As Discord sends these CHANNEL UPDATE replies as individual events in an asynchronous manner instead of as a single response to our `bulk channels update` request, there's nothing much we can do about this. However, I have yet to observe this, so maybe it will never happen.
2020-04-27Add DMChannel tests for in_whitelist decoratorGravatar Sebastiaan Zeeff-31/+63
The `in_whitelist` decorator should not fail when a decorated command was called in a DMChannel; it should simply conclude that the user is not allowed to use the command. I've added a test case that uses a DMChannel context with User, not Member, objects. In addition, I've opted to display a test case description in the `subTest`: Simply printing the actual arguments and context is messy and does not actually show you the information you'd like. This description is enough to figure out which test is failing and what the gist of the test is.
2020-04-27Add mock for discord.DMChannelsGravatar Sebastiaan Zeeff-0/+21
2020-04-27Exclude never-run lines from coverageGravatar Sebastiaan Zeeff-2/+2
2020-04-24Fix awaiting non-coroutine when closing the statsd transportGravatar MarkKoz-1/+1
`BaseTransport.close()` is not a coroutine and therefore should not be awaited.
2020-04-23Simplify `in_whitelisted_context` decorator APIGravatar Sebastiaan Zeeff-92/+72
The API of the `in_whitelisted_context` decorator was a bit clunky: - The long parameter names frequently required multiline decorators - Despite `#bot-commands` being the defacto default, it needed to be passed - The name of the function, `in_whitelisted_context` is fairly long in itself To shorten the call length of the decorator, the parameter names were shortened by dropping the `whitelisted_` prefix. This means that the parameter names are now just `channels`, `categories`, and `roles`. This already means that all current usages of the decorator are reduced to one line. In addition, `#bot-commands` has now been made the default redirect channel for the decorator. This means that if no `redirect` was passed, users will be redirected to `bot-commands` to use the command. If needed, `None` (or any falsey value) can be passed to disable redirection. Passing another channel id will trigger that channel to be used as the redirection target instead of bot-commands. Finally, the name of the decorator was shortened to `in_whitelist`, which already communicates what it is supposed to do.
2020-04-23Allow `!eval` in help channel categoriesGravatar Sebastiaan Zeeff-1/+3
As help conversations now take place in their own, dedicated channels, there's no longer a pressing need to restrict the `!eval` command in help channels for regular members. As the command can be a valuable tool in explaining and teaching Python, we've therefore chosen to allow it in channels in `Help: Available` and `Help: Occupied` catagories.