refactor(AccessLogsExport): export in background TASK-1145 #5216
Conversation
This file contains 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
…rtTask and add tests
RuthShryock
changed the title
RuthShryock
changed the title
rgraber
requested changes
Nov 4, 2024
| from kpi.tasks import export_task_in_background | ||
|
|
||
|
|
||
| class ExportTaskInBackgroundTests(TestCase): |
There was a problem hiding this comment.
You can patch the whole class at once instead of each individual method
Suggested change
| class ExportTaskInBackgroundTests(TestCase): | |
| @patch('django.core.mail.send_mail') | |
| @patch('kobo.apps.project_views.models.project_view.ProjectView.objects.get') | |
| class ExportTaskInBackgroundTests(TestCase): |
kpi/tests/test_export_tasks.py
Outdated
| self.task.refresh_from_db() | ||
| self.assertEqual(self.task.status, 'complete') | ||
|
|
||
| mock_send_mail.assert_called_once() |
There was a problem hiding this comment.
shortcut: you can use assert_called_once_with and pass the expected arguments
kpi/tasks.py
Outdated
| ) -> None: | ||
| user = User.objects.get(username=username) | ||
|
|
||
| export_task = ProjectViewExportTask.objects.get(uid=export_task_uid) | ||
| export_task_class = apps.get_model(f'kpi.{export_task_name}') |
There was a problem hiding this comment.
I believe this will break if we have tasks defined outside kpi/tasks.py. Better to just pass the fully qualified name of the task model.
RuthShryock
requested review from
jnm,
noliveleger and
magicznyleszek
as code owners
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.
Checklist
./python-format.shto make sure that your code lints and that you've followed our coding styleDescription
Refactor our export task function to handle different project type inputs.
Notes
send_mailis now accessed via themailmodule instead of being imported directly. This was changed to allow for mocking ofsend_mailin the tests.Testing
Most testing is covered by the tests but you can also ensure that the
Export all databutton in Project views is exporting data and sending an email.