aboutsummaryrefslogtreecommitdiffstats
path: root/tests (follow)
Commit message (Collapse)AuthorAgeLines
...
| | * | | | | Remove unused `chunks` function and its tests.Gravatar Numerlor2020-02-24-15/+0
| | | |/ / / | | |/| | | | | | | | | | | | | | | The function was only used in the since removed `Events` cog.
| * | | | | Adjust tests for new converter behavior.Gravatar Numerlor2020-02-26-1/+1
| | |/ / / | |/| | |
* | | | | Use MagicMock as return value for _get_diff mockGravatar Sebastiaan Zeeff2020-02-24-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The `_get_diff` method of TestSyncer class is mocked using an AsyncMock object. By default, when an AsyncMock object is called **and awaited**, it returns a child mock of the same time (another AsyncMock) according to the "the child is a like the parent" principle. This means that the _get_diff method will return an AsyncMock unless a different return_value is explicitly provided. Because of that "child is like parent" behavior, this will happen in lines 194-196 of bot.cogs.sync.syncers (annotations added by me): ``` // `diff` will be a child AsyncMock as "child is like parent" diff = await self._get_diff(guild) // `diff._asdict` will be an AsyncMock as "child is like parent" and, // after being called, it will return an unawaited coroutine object // we assign the name `diff_dict`: diff_dict = diff._asdict() // `diff_dict` is still an unawaited coroutine object meaning that it // doesn't have an `items()` method: totals = {k: len(v) for k, v in diff_dict.items() if v is not None} ``` Original, unannotated: https://github.com/python-discord/bot/blob/c81a4d401ea434e98b0a1ece51d3d10f1a3ad226/bot/cogs/sync/syncers.py#L194-L196 This will lead to the following exception when running the tests: ```py ====================================================================== ERROR: test_sync_confirmation_context_redirect (tests.bot.cogs.sync.test_base.SyncerSyncTests) (ctx=None, author=<MockMember name='mock.user' spec_set='Member' id='140583452034864'>, message=None) If ctx is given, a new message should be sent and author should be ctx's author. ---------------------------------------------------------------------- Traceback (most recent call last): File "/home/sebastiaan/pydis/repositories/bot/tests/bot/cogs/sync/test_base.py", line 348, in test_sync_confirmation_context_redirect await self.syncer.sync(guild, ctx) File "/home/sebastiaan/pydis/repositories/bot/bot/cogs/sync/syncers.py", line 196, in sync totals = {k: len(v) for k, v in diff_dict.items() if v is not None} AttributeError: 'coroutine' object has no attribute 'items' ``` The solution is to assign an explicit return value so the parent mock doesn't "guess" and return an object of its own type. I previously did that by providing a specific `_Diff` object as the return value, but I should have gone with a `MagicMock` to signify that it's not an important return value; it's just something that needs to support/mimic the API we use on it. So that's what this commit adds.
* | | | | Sync tests: use autospec instead of MockSyncerGravatar MarkKoz2020-02-23-18/+4
| | | | | | | | | | | | | | | | | | | | | | | | | Autospec supports using AsyncMocks in 3.8 so there's no need to rely on a subclass of CustomMockMixin for the async mocks.
* | | | | Migrate syncers test suite to Python 3.8Gravatar Sebastiaan Zeeff2020-02-24-75/+34
| | | | | | | | | | | | | | | | | | | | The test suite for the new role/member syncers used the "old"-style test suite with the helpers implemented for Python 3.7. I have migrated it to use the new Python 3.8 asyncio test helpers.
* | | | | Use realistic mixin implementationGravatar Sebastiaan Zeeff2020-02-24-1/+1
| | | | | | | | | | | | | | | | | | | | Instead of using the mixin class bare, I've now included into a class tha subclasses unittest.TestCase as that's how it's going to be used "in the wild".
* | | | | Merge branch 'master' into python38-migrationGravatar Sebastiaan Zeeff2020-02-24-210/+1198
|\| | | |
| * | | | Merge remote-tracking branch 'origin/master' into ↵Gravatar MarkKoz2020-02-23-246/+642
| |\| | | | | | | | | | | | | | | | | | bug/backend/b704/ready-missing-cache
| * | | | Sync: add confirmation timeout and max diff to configGravatar MarkKoz2020-02-19-2/+2
| | | | |
| * | | | Tests: fix unawaited error for MockAPIClientGravatar MarkKoz2020-02-12-5/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This error is due to the use of an actual instance of APIClient as the spec for the mock. recreate() is called in __init__ which in turn creates a task for the _create_session coroutine. The approach to the solution is to use the type for the spec rather than and instance, thus avoiding any call of __init__. However, without an instance, instance attributes will not be included in the spec. Therefore, they are defined as class attributes on the actual APIClient class definition and given default values. Alternatively, a subclass of APIClient could have been made in the tests.helpers module to define those class attributes. However, it seems easier to maintain if the attributes are in the original class definition.
| * | | | Sync tests: use async_test decoratorGravatar MarkKoz2020-02-12-94/+135
| | | | |
| * | | | Sync tests: test on_member_joinGravatar MarkKoz2020-02-12-0/+52
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Should PUT user's data or POST it if the user doesn't exist. ResponseCodeError should be re-raised if status code isn't a 404. A helper method was added to reduce code redundancy between the 2 tests.
| * | | | Sync tests: add a third role with a lower ID to on_member_update testGravatar MarkKoz2020-02-12-1/+2
| | | | | | | | | | | | | | | | | | | | This better ensures that roles are being sorted when patching.
| * | | | Sync tests: fix on_member_remove listener testGravatar MarkKoz2020-02-12-13/+6
| | | | | | | | | | | | | | | | | | | | | | | | | The listener was changed earlier to simply set in_guild to False. This commit accounts for that in the test.
| * | | | Sync tests: assert that listeners are actually added as listenersGravatar MarkKoz2020-02-12-0/+14
| | | | |
| * | | | Sync tests: test sync commands require the admin permissionGravatar MarkKoz2020-02-12-1/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The sync commands should only run if the author has the administrator permission. * Add missing spaces after class docstrings * Add missing docstring to SyncCogCommandTests
| * | | | Tests: create TestCase subclass with a permissions check assertionGravatar MarkKoz2020-02-12-0/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The subclass will contain assertions that are useful for testing Discord commands. The currently included assertion tests that a command will raise a MissingPermissions exception if the author lacks permissions.
| * | | | Sync tests: test sync users commandGravatar MarkKoz2020-02-12-0/+7
| | | | | | | | | | | | | | | | | | | | sync() should be called on the UserSyncer.
| * | | | Sync tests: test sync roles commandGravatar MarkKoz2020-02-12-0/+9
| | | | | | | | | | | | | | | | | | | | sync() should be called on the RoleSyncer.
| * | | | Sync tests: test Sync cog's on_user_updateGravatar MarkKoz2020-02-12-1/+42
| | | | | | | | | | | | | | | | | | | | | | | | | A user should be patched only if the name, discriminator, or avatar changes.
| * | | | Sync tests: fix ID in endpoint for test_sync_cog_on_member_removeGravatar MarkKoz2020-02-12-1/+1
| | | | |
| * | | | Sync tests: test Sync cog's on_member_update for other attributesGravatar MarkKoz2020-02-12-0/+21
| | | | | | | | | | | | | | | | | | | | Members should not be patched if other attributes have changed.
| * | | | Sync tests: test Sync cog's on_member_update for rolesGravatar MarkKoz2020-02-12-0/+11
| | | | | | | | | | | | | | | | | | | | Members should be patched if their roles have changed.
| * | | | Sync tests: test Sync cog's on_member_removeGravatar MarkKoz2020-02-12-0/+17
| | | | | | | | | | | | | | | | | | | | | | | | | A PUT request should be sent to set in_guild as False and update other fields.
| * | | | Sync tests: test Sync cog's on_guild_role_updateGravatar MarkKoz2020-02-12-0/+35
| | | | | | | | | | | | | | | | | | | | | | | | | A PUT request should be sent if the colour, name, permissions, or position changes.
| * | | | Sync tests: remove mock_role fixtureGravatar MarkKoz2020-02-12-19/+4
| | | | | | | | | | | | | | | | | | | | | | | | | It is obsolete because MockRole now takes care of creating the Colour and Permissions objects.
| * | | | Tests: use objects for colour and permissions of MockRoleGravatar MarkKoz2020-02-12-1/+13
| | | | | | | | | | | | | | | | | | | | | | | | | Instances of discord.Colour and discord.Permissions will be created by default or when ints are given as values for those attributes.
| * | | | Sync tests: test Sync cog's on_guild_role_delete listenerGravatar MarkKoz2020-02-12-0/+7
| | | | | | | | | | | | | | | | | | | | A DELETE request should be sent.
| * | | | Sync tests: test Sync cog's on_guild_role_create listenerGravatar MarkKoz2020-02-12-0/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A POST request should be sent with the new role's data. * Add a fixture to create a MockRole
| * | | | Sync tests: create a test case for listener testsGravatar MarkKoz2020-02-12-0/+7
| | | | |
| * | | | Sync tests: create a base TestCase class for Sync cog testsGravatar MarkKoz2020-02-12-2/+6
| | | | |
| * | | | Sync tests: add helper function for testing patch_userGravatar MarkKoz2020-02-12-8/+15
| | | | | | | | | | | | | | | | | | | | | | | | | Reduces redundancy in the tests by taking care of the mocks, calling of the function, and the assertion.
| * | | | Sync tests: test patch_userGravatar MarkKoz2020-02-12-0/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A PATCH request should be sent. The error should only be raised if it is not a 404. * Add a fixture to create ResponseCodeErrors with a specific status
| * | | | Sync tests: test sync_guildGravatar MarkKoz2020-02-12-0/+24
| | | | | | | | | | | | | | | | | | | | | | | | | Roles and users should be synced only if a guild is successfully retrieved.
| * | | | Sync tests: fix Syncer mocks not having async methodsGravatar MarkKoz2020-02-12-2/+23
| | | | | | | | | | | | | | | | | | | | | | | | | While on 3.7, the CustomMockMixin needs to be leveraged so that coroutine members are replace with AsyncMocks instead.
| * | | | Sync tests: use mock.patch for sync_guildGravatar MarkKoz2020-02-12-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | This prevents persistence of changes to the cog instance; sync_guild would otherwise remain as a mock object for any subsequent tests.
| * | | | Sync tests: instantiate a Sync cog in setUpGravatar MarkKoz2020-02-12-5/+19
| | | | | | | | | | | | | | | | | | | | * Move patches to setUp
| * | | | Sync tests: test Sync cog __init__Gravatar MarkKoz2020-02-12-0/+21
| | | | | | | | | | | | | | | | | | | | Should instantiate syncers and run a sync for the guild.
| * | | | Sync tests: test the extension setupGravatar MarkKoz2020-02-12-0/+15
| | | | | | | | | | | | | | | | | | | | The Sync cog should be added.
| * | | | Sync tests: test _get_confirmation_result for large diffsGravatar MarkKoz2020-02-12-0/+29
| | | | | | | | | | | | | | | | | | | | | | | | | Should return True if confirmed and False if _send_prompt fails or aborted.
| * | | | Sync tests: test _get_confirmation_result for small diffsGravatar MarkKoz2020-02-12-0/+19
| | | | | | | | | | | | | | | | | | | | | | | | | Should always return True and the given message if the diff size is too small.
| * | | | Sync tests: test sync edits message even if there's an API errorGravatar MarkKoz2020-02-12-4/+12
| | | | |
| * | | | Sync tests: test sync redirects confirmation message to given contextGravatar MarkKoz2020-02-12-6/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If ctx is given, a new message should be sent and author should be ctx's author. test_sync_confirmation_author was re-worked to include a test for the message being sent and passed.
| * | | | Sync tests: test sync passes correct author for confirmationGravatar MarkKoz2020-02-12-1/+19
| | | | | | | | | | | | | | | | | | | | Author should be the bot or the ctx author, if a ctx is given.
| * | | | Sync tests: test sync edits the message if one was sentGravatar MarkKoz2020-02-12-0/+15
| | | | |
| * | | | Sync tests: test diff size calculationGravatar MarkKoz2020-02-12-0/+22
| | | | |
| * | | | Sync tests: adjust sync test to account for _get_confirmation_resultGravatar MarkKoz2020-02-12-23/+13
| | | | |
| * | | | Sync tests: test sync sends a confirmation promptGravatar MarkKoz2020-02-12-12/+36
| | | | | | | | | | | | | | | | | | | | | | | | | The prompt should be sent only if the diff is large and should fail if not confirmed. The empty diff test was integrated into this new test.
| * | | | Sync tests: test sync with an empty diffGravatar MarkKoz2020-02-12-1/+25
| | | | | | | | | | | | | | | | | | | | A confirmation prompt should not be sent if the diff is too small.
| * | | | Sync tests: test _wait_for_confirmationGravatar MarkKoz2020-02-12-0/+38
| | | | | | | | | | | | | | | | | | | | | | | | | The message should always be edited and only return True if the emoji is a check mark.