-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
23 changed files
with
592 additions
and
31 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
from django.core.management.base import BaseCommand | ||
from akvo.rsr.views.py_reports.email_report import run_job | ||
|
||
|
||
class Command(BaseCommand): | ||
|
||
def handle(self, *args, **options): | ||
run_job() |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Generated by Django 3.2.10 on 2022-09-01 07:09 | ||
|
||
from django.db import migrations, models | ||
|
||
|
||
class Migration(migrations.Migration): | ||
|
||
dependencies = [ | ||
('rsr', '0219_iatiactivityvalidationjob_iatiorganisationvalidationjob'), | ||
] | ||
|
||
operations = [ | ||
migrations.CreateModel( | ||
name='EmailReportJob', | ||
fields=[ | ||
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), | ||
('created_at', models.DateTimeField(auto_now_add=True, db_index=True, null=True)), | ||
('started_at', models.DateTimeField(null=True)), | ||
('finished_at', models.DateTimeField(null=True)), | ||
('attempts', models.PositiveSmallIntegerField(default=0)), | ||
('report', models.CharField(max_length=100)), | ||
('payload', models.JSONField(default=dict)), | ||
('recipient', models.EmailField(max_length=254)), | ||
], | ||
), | ||
] |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
from django.db import models | ||
from django.utils.timezone import now | ||
|
||
|
||
class EmailReportJob(models.Model): | ||
created_at = models.DateTimeField(null=True, auto_now_add=True, db_index=True, editable=False) | ||
started_at = models.DateTimeField(null=True) | ||
finished_at = models.DateTimeField(null=True) | ||
attempts = models.PositiveSmallIntegerField(default=0) | ||
report = models.CharField(max_length=100) | ||
payload = models.JSONField(default=dict) | ||
recipient = models.EmailField() | ||
|
||
def mark_started(self): | ||
self.started_at = now() | ||
self.attempts = self.attempts + 1 | ||
self.save(update_fields=['started_at', 'attempts']) | ||
|
||
def mark_finished(self): | ||
self.finished_at = now() | ||
self.save(update_fields=['finished_at']) |
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
Empty file.
50 changes: 50 additions & 0 deletions
50
akvo/rsr/tests/views/py_reports/test_send_report_via_email.py
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
from django.core import management | ||
from django.core import mail | ||
from django.urls import reverse | ||
from parameterized import parameterized | ||
from akvo.rsr.tests.base import BaseTestCase | ||
from akvo.rsr.models import EmailReportJob, Country | ||
from akvo.rsr.views.py_reports import ( | ||
program_overview_pdf_report, | ||
program_overview_excel_report, | ||
program_period_labels_overview_pdf_report, | ||
results_indicators_with_map_pdf_reports, | ||
nuffic_country_level_map_report, | ||
) | ||
|
||
|
||
class SendReportViaEmailTestCase(BaseTestCase): | ||
|
||
def setUp(self): | ||
super().setUp() | ||
self.program = self.create_program('Test program') | ||
self.user = self.create_user('test@akvo.org', 'password', is_admin=True) | ||
Country.objects.get_or_create(iso_code='nl') | ||
self.c.login(username=self.user.email, password='password') | ||
mail.outbox = [] | ||
|
||
def test_add_job(self): | ||
response = self.c.get(reverse('py-reports-program-overview', args=(self.program.id,))) | ||
self.assertEqual(202, response.status_code) | ||
self.assertEqual(1, EmailReportJob.objects.count()) | ||
job = EmailReportJob.objects.first() | ||
self.assertEqual(program_overview_pdf_report.REPORT_NAME, job.report) | ||
|
||
@parameterized.expand([ | ||
('py-reports-program-overview', '', program_overview_pdf_report.REPORT_NAME), | ||
('py-reports-program-overview-table', '', program_overview_excel_report.REPORT_NAME), | ||
('py-reports-program-period-labels-overview', '', program_period_labels_overview_pdf_report.REPORT_NAME), | ||
('py-reports-organisation-projects-results-indicators-map-overview', 'country=nl', results_indicators_with_map_pdf_reports.ORG_PROJECTS_REPORT_NAME), | ||
('py-reports-nuffic-country-level-report', 'country=nl', nuffic_country_level_map_report.REPORT_NAME), | ||
]) | ||
def test_send_report_via_email(self, url_name, query_params, report_name): | ||
self.c.get(f"{reverse(url_name, args=(self.program.id,))}?{query_params}") | ||
job = EmailReportJob.objects.first() | ||
self.assertEqual(report_name, job.report) | ||
self.assertEqual(1, EmailReportJob.objects.filter(finished_at__isnull=True).count()) | ||
|
||
management.call_command('send_report_via_email') | ||
|
||
self.assertEqual(0, EmailReportJob.objects.filter(finished_at__isnull=True).count()) | ||
msg = mail.outbox[0] | ||
self.assertEqual([self.user.email], msg.to) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
import logging | ||
|
||
from datetime import timedelta | ||
from django.db.models import Q | ||
from django.utils.timezone import now | ||
from akvo.rsr.models import EmailReportJob | ||
|
||
from . import ( | ||
program_overview_pdf_report, | ||
program_overview_excel_report, | ||
program_period_labels_overview_pdf_report, | ||
results_indicators_with_map_pdf_reports, | ||
nuffic_country_level_map_report, | ||
) | ||
|
||
TIMEOUT = timedelta(minutes=30) | ||
MAX_ATTEMPTS = 3 | ||
HANDLER = { | ||
program_overview_pdf_report.REPORT_NAME: program_overview_excel_report.handle_email_report, | ||
program_overview_excel_report.REPORT_NAME: program_overview_excel_report.handle_email_report, | ||
program_period_labels_overview_pdf_report.REPORT_NAME: program_period_labels_overview_pdf_report.handle_email_report, | ||
results_indicators_with_map_pdf_reports.ORG_PROJECTS_REPORT_NAME: results_indicators_with_map_pdf_reports.handle_org_projects_email_report, | ||
nuffic_country_level_map_report.REPORT_NAME: nuffic_country_level_map_report.handle_email_report, | ||
} | ||
|
||
logger = logging.getLogger(__name__) | ||
|
||
|
||
def run_job(): | ||
pending_jobs = _get_pending_jobs() | ||
if not pending_jobs.exists(): | ||
return | ||
job = pending_jobs.first() | ||
job.mark_started() | ||
try: | ||
handler = _get_report_handler(job.report) | ||
if handler: | ||
handler(job.payload, job.recipient) | ||
job.mark_finished() | ||
except Exception: | ||
logger.exception(f'Failed to genereate report {job.report} for {job.recipient}') | ||
|
||
|
||
def _get_pending_jobs(): | ||
started_timeout = now() - TIMEOUT | ||
return EmailReportJob.objects\ | ||
.order_by('created_at')\ | ||
.filter(finished_at__isnull=True)\ | ||
.exclude(Q(attempts__gte=MAX_ATTEMPTS) | Q(started_at__gte=started_timeout)) | ||
|
||
|
||
def _get_report_handler(report): | ||
return HANDLER[report] if report in HANDLER else None |
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
Oops, something went wrong.