diff --git a/backend/dissemination/test_views.py b/backend/dissemination/test_views.py
index 35f0e01561..012267a33b 100644
--- a/backend/dissemination/test_views.py
+++ b/backend/dissemination/test_views.py
@@ -448,3 +448,140 @@ def test_summary_context(self):
response.context["data"]["Notes to SEFA"][0]["accounting_policies"],
note.accounting_policies,
)
+
+
+class SummaryReportDownloadViewTests(TestCase):
+ def setUp(self):
+ self.anon_client = Client()
+ self.perm_client = Client()
+
+ self.perm_user = baker.make(User)
+ permission = Permission.objects.get(slug=Permission.PermissionType.READ_TRIBAL)
+ baker.make(
+ UserPermission,
+ email=self.perm_user.email,
+ user=self.perm_user,
+ permission=permission,
+ )
+ self.perm_client.force_login(self.perm_user)
+
+ def _make_general(self, is_public=True, **kwargs):
+ """
+ Create a General object in dissemination with the keyword arguments passed in.
+ """
+ general = baker.make(
+ General,
+ is_public=is_public,
+ **kwargs,
+ )
+ return general
+
+ def _summary_report_url(self):
+ return reverse("dissemination:MultipleSummaryReportDownload")
+
+ def _mock_filename(self):
+ return "some-report-name.xlsx"
+
+ def _mock_download_url(self):
+ return "http://example.com/gsa-fac-private-s3/temp/some-report-name.xlsx"
+
+ @patch("dissemination.summary_reports.persist_workbook")
+ def test_bad_search_returns_400(self, mock_persist_workbook):
+ """
+ Submitting a form with bad parameters should throw a BadRequest.
+ """
+ response = self.anon_client.post(
+ self._summary_report_url(), {"start_date": "Not a date"}
+ )
+ self.assertEquals(response.status_code, 400)
+
+ @patch("dissemination.summary_reports.persist_workbook")
+ def test_empty_results_returns_404(self, mock_persist_workbook):
+ """
+ Searches with no results should return a 404, not an empty excel file.
+ """
+ self._make_general(is_public=False, auditee_uei="123456789012")
+ response = self.anon_client.post(
+ self._summary_report_url(), {"uei_or_ein": "NotTheOther1"}
+ )
+ self.assertEquals(response.status_code, 404)
+
+ @patch("dissemination.summary_reports.persist_workbook")
+ def test_no_permissions_returns_404_on_private(self, mock_persist_workbook):
+ """
+ Non-permissioned users cannot access private audits through the summary report post.
+ """
+ self._make_general(is_public=False)
+ response = self.anon_client.post(self._summary_report_url(), {})
+ self.assertEquals(response.status_code, 404)
+
+ @patch("dissemination.views.get_download_url")
+ @patch("dissemination.summary_reports.persist_workbook")
+ def test_permissions_returns_file_on_private(
+ self, mock_persist_workbook, mock_get_download_url
+ ):
+ """
+ Permissioned users recieve a file if there are private results.
+ """
+ mock_persist_workbook.return_value = self._mock_filename()
+ mock_get_download_url.return_value = self._mock_download_url()
+
+ self._make_general(is_public=False)
+
+ response = self.perm_client.post(self._summary_report_url(), {})
+ self.assertRedirects(
+ response,
+ self._mock_download_url(),
+ status_code=302,
+ target_status_code=200,
+ fetch_redirect_response=False,
+ )
+
+ @patch("dissemination.views.get_download_url")
+ @patch("dissemination.summary_reports.persist_workbook")
+ def test_empty_search_params_returns_file(
+ self, mock_persist_workbook, mock_get_download_url
+ ):
+ """
+ File should be generated on empty search parameters ("search all").
+ """
+ mock_persist_workbook.return_value = self._mock_filename()
+ mock_get_download_url.return_value = self._mock_download_url()
+
+ self._make_general(is_public=True)
+
+ response = self.anon_client.post(self._summary_report_url(), {})
+ self.assertRedirects(
+ response,
+ self._mock_download_url(),
+ status_code=302,
+ target_status_code=200,
+ fetch_redirect_response=False,
+ )
+
+ @patch("dissemination.views.get_download_url")
+ @patch("dissemination.summary_reports.persist_workbook")
+ def test_many_results_returns_file(
+ self, mock_persist_workbook, mock_get_download_url
+ ):
+ """
+ File should still be generated if there are above SUMMARY_REPORT_DOWNLOAD_LIMIT total results.
+ """
+ mock_persist_workbook.return_value = self._mock_filename()
+ mock_get_download_url.return_value = self._mock_download_url()
+
+ for i in range(4):
+ self._make_general(
+ is_public=True,
+ report_id=generate_sac_report_id(end_date="2023-12-31", count=str(i)),
+ )
+
+ with self.settings(SUMMARY_REPORT_DOWNLOAD_LIMIT=2):
+ response = self.anon_client.post(self._summary_report_url(), {})
+ self.assertRedirects(
+ response,
+ self._mock_download_url(),
+ status_code=302,
+ target_status_code=200,
+ fetch_redirect_response=False,
+ )
diff --git a/backend/dissemination/urls.py b/backend/dissemination/urls.py
index d6b5a631cf..cdd1793ce6 100644
--- a/backend/dissemination/urls.py
+++ b/backend/dissemination/urls.py
@@ -17,9 +17,14 @@
),
path(
"summary-report/xlsx/
",
- views.SummaryReportDownloadView.as_view(),
+ views.SingleSummaryReportDownloadView.as_view(),
name="SummaryReportDownload",
),
+ path(
+ "summary-report/xlsx",
+ views.MultipleSummaryReportDownloadView.as_view(),
+ name="MultipleSummaryReportDownload",
+ ),
path("search/", views.Search.as_view(), name="Search"),
path("summary/", views.AuditSummaryView.as_view(), name="Summary"),
]
diff --git a/backend/dissemination/views.py b/backend/dissemination/views.py
index 75c722a6f6..78988318f9 100644
--- a/backend/dissemination/views.py
+++ b/backend/dissemination/views.py
@@ -1,3 +1,5 @@
+from collections import namedtuple
+import logging
import math
from django.core.exceptions import BadRequest
@@ -8,7 +10,7 @@
from audit.models import SingleAuditChecklist
-from config.settings import STATE_ABBREVS
+from config.settings import STATE_ABBREVS, SUMMARY_REPORT_DOWNLOAD_LIMIT
from dissemination.file_downloads import get_download_url, get_filename
from dissemination.forms import SearchForm
@@ -29,8 +31,13 @@
from users.permissions import can_read_tribal
+logger = logging.getLogger(__name__)
+
def include_private_results(request):
+ """
+ Determine if the user is authenicated to see private data.
+ """
if not request.user.is_authenticated:
return False
@@ -40,8 +47,83 @@ def include_private_results(request):
return True
+def clean_form_data(form):
+ """
+ Given a SearchForm, return a namedtuple with its cleaned and formatted data.
+ Ideally, this makes accessing form data later a little more readable.
+ """
+ FormData = namedtuple(
+ "FormData",
+ "uei_or_eins alns names start_date end_date cog_or_oversight agency_name audit_years auditee_state order_by order_direction limit page",
+ )
+
+ if form.is_valid():
+ uei_or_eins = form.cleaned_data["uei_or_ein"].splitlines()
+ alns = form.cleaned_data["aln"].replace(", ", " ").split()
+ names = form.cleaned_data["entity_name"].splitlines()
+ start_date = form.cleaned_data["start_date"]
+ end_date = form.cleaned_data["end_date"]
+ cog_or_oversight = form.cleaned_data["cog_or_oversight"]
+ agency_name = form.cleaned_data["agency_name"]
+ audit_years = [
+ int(year) for year in form.cleaned_data["audit_year"]
+ ] # Cast strings from HTML to int
+ auditee_state = form.cleaned_data["auditee_state"]
+ order_by = form.cleaned_data["order_by"]
+ order_direction = form.cleaned_data["order_direction"]
+
+ # TODO: Add a limit choice field to the form
+ limit = form.cleaned_data["limit"] or 30
+ page = int(form.cleaned_data["page"] or 1)
+
+ form_data = FormData(
+ uei_or_eins,
+ alns,
+ names,
+ start_date,
+ end_date,
+ cog_or_oversight,
+ agency_name,
+ audit_years,
+ auditee_state,
+ order_by,
+ order_direction,
+ limit,
+ page,
+ )
+
+ else:
+ raise BadRequest("Form data validation error.", form.errors)
+
+ return form_data
+
+
+def run_search_general(form_data, include_private):
+ """
+ Given cleaned form data and an 'include_private' boolean, run the search.
+ Returns the results QuerySet.
+ """
+ return search_general(
+ names=form_data.names,
+ alns=form_data.alns,
+ uei_or_eins=form_data.uei_or_eins,
+ start_date=form_data.start_date,
+ end_date=form_data.end_date,
+ cog_or_oversight=form_data.cog_or_oversight,
+ agency_name=form_data.agency_name,
+ audit_years=form_data.audit_years,
+ auditee_state=form_data.auditee_state,
+ include_private=include_private,
+ order_by=form_data.order_by,
+ order_direction=form_data.order_direction,
+ )
+
+
class Search(View):
def get(self, request, *args, **kwargs):
+ """
+ When accessing the search page through get, return the blank search page.
+ """
form = SearchForm()
return render(
@@ -54,78 +136,50 @@ def get(self, request, *args, **kwargs):
)
def post(self, request, *args, **kwargs):
+ """
+ When accessing the search page through post, run a search and display the results.
+ """
form = SearchForm(request.POST)
results = []
context = {}
- if form.is_valid():
- uei_or_eins = form.cleaned_data["uei_or_ein"].splitlines()
- alns = form.cleaned_data["aln"].replace(", ", " ").split()
- names = form.cleaned_data["entity_name"].splitlines()
- start_date = form.cleaned_data["start_date"]
- end_date = form.cleaned_data["end_date"]
- cog_or_oversight = form.cleaned_data["cog_or_oversight"]
- agency_name = form.cleaned_data["agency_name"]
- audit_years = [
- int(year) for year in form.cleaned_data["audit_year"]
- ] # Cast strings from HTML to int
- auditee_state = form.cleaned_data["auditee_state"]
- order_by = form.cleaned_data["order_by"]
- order_direction = form.cleaned_data["order_direction"]
-
- # TODO: Add a limit choice field to the form
- limit = form.cleaned_data["limit"] or 30
- # Changed in the form via pagination links
- page = int(form.cleaned_data["page"] or 1)
-
- # is the user authenticated?
- include_private = include_private_results(request)
+ form_data = clean_form_data(form)
+ include_private = include_private_results(request)
+ results = run_search_general(form_data, include_private)
+
+ results_count = len(results)
+ # Reset page to one if the page number surpasses how many pages there actually are
+ page = form_data.page
+ if page > math.ceil(results_count / form_data.limit):
+ page = 1
+
+ # The paginator object handles splicing the results to a one-page iterable and calculates which page numbers to show.
+ paginator = Paginator(object_list=results, per_page=form_data.limit)
+ results = paginator.get_page(form_data.page)
+ results.adjusted_elided_pages = paginator.get_elided_page_range(
+ form_data.page, on_each_side=1
+ )
- results = search_general(
- names=names,
- alns=alns,
- uei_or_eins=uei_or_eins,
- start_date=start_date,
- end_date=end_date,
- cog_or_oversight=cog_or_oversight,
- agency_name=agency_name,
- audit_years=audit_years,
- auditee_state=auditee_state,
- include_private=include_private,
- order_by=order_by,
- order_direction=order_direction,
+ # Reformat these so the date-picker elements in HTML prepopulate
+ if form.cleaned_data["start_date"]:
+ form.cleaned_data["start_date"] = form.cleaned_data["start_date"].strftime(
+ "%Y-%m-%d"
+ )
+ if form.cleaned_data["end_date"]:
+ form.cleaned_data["end_date"] = form.cleaned_data["end_date"].strftime(
+ "%Y-%m-%d"
)
- results_count = len(results)
- # Reset page to one if the page number surpasses how many pages there actually are
- if page > math.ceil(results_count / limit):
- page = 1
-
- paginator = Paginator(object_list=results, per_page=limit)
- results = paginator.get_page(page) # List of size objects
- results.adjusted_elided_pages = paginator.get_elided_page_range(
- page, on_each_side=1
- ) # Pagination buttons, adjust ellipses around the current page
-
- # Reformat these so the date-picker elements in HTML prepopulate
- if form.cleaned_data["start_date"]:
- form.cleaned_data["start_date"] = start_date.strftime("%Y-%m-%d")
- if form.cleaned_data["end_date"]:
- form.cleaned_data["end_date"] = end_date.strftime("%Y-%m-%d")
- else:
- raise BadRequest("Form data validation error.", form.errors)
-
- if order_by is None:
- order_by = "acceptance_date"
context = context | {
"form": form,
"state_abbrevs": STATE_ABBREVS,
- "limit": limit,
+ "limit": form_data.limit,
"results": results,
"results_count": results_count,
"page": page,
- "order_by": order_by,
- "order_direction": order_direction,
+ "order_by": form_data.order_by,
+ "order_direction": form_data.order_direction,
+ "summary_report_download_limit": SUMMARY_REPORT_DOWNLOAD_LIMIT,
}
return render(request, "search.html", context)
@@ -134,10 +188,10 @@ def post(self, request, *args, **kwargs):
class AuditSummaryView(ReportAccessRequiredMixin, View):
def get(self, request, report_id):
"""
- Grab any information about the given report in the dissemination tables.
- 1. See if this audit is available in the dissemination tables. If not, 404.
- 2. Grab all relevant info from dissem tables. Some items may not exist if they had no findings.
- 3. Wrap up the data all nice in a context object for display.
+ Display information about the given report in the dissemination tables.
+ 1. See if this audit is available. If not, 404.
+ 2. Grab all relevant info from the dissemination tables.
+ 3. Wrap the data into a context object for display.
"""
# Viewable audits __MUST__ be public.
general = General.objects.filter(report_id=report_id)
@@ -150,7 +204,7 @@ def get(self, request, report_id):
data = self.get_audit_content(report_id)
- # Add entity name and UEI to the context, for the footer bit.
+ # Add entity name and UEI to the context, for the footer.
context = {
"report_id": report_id,
"auditee_name": general_data["auditee_name"],
@@ -165,8 +219,6 @@ def get_audit_content(self, report_id):
"""
Grab everything relevant from the dissemination tables.
Wrap that data into a dict, and return it.
- We may want to define additional functions to squish this information down
- further. I.e. remove DB ids or something.
"""
awards = FederalAward.objects.filter(report_id=report_id)
audit_findings = Finding.objects.filter(report_id=report_id)
@@ -179,10 +231,8 @@ def get_audit_content(self, report_id):
data = {}
- data["Awards"] = [
- x for x in awards.values()
- ] # Take QuerySet to a list of objects
-
+ # QuerySet values to an array of dicts
+ data["Awards"] = [x for x in awards.values()]
if notes_to_sefa.exists():
data["Notes to SEFA"] = [x for x in notes_to_sefa.values()]
if audit_findings.exists():
@@ -205,6 +255,10 @@ def get_audit_content(self, report_id):
class PdfDownloadView(ReportAccessRequiredMixin, View):
def get(self, request, report_id):
+ """
+ Given a report_id in the URL, find the relevant PDF in S3 and
+ redirect to the download link.
+ """
# only allow PDF downloads for disseminated submissions
get_object_or_404(General, report_id=report_id)
@@ -216,6 +270,10 @@ def get(self, request, report_id):
class XlsxDownloadView(ReportAccessRequiredMixin, View):
def get(self, request, report_id, file_type):
+ """
+ Given a report_id and workbook section (file_type) in the URL,
+ find the relevant XLSX file in S3 and redirect to its download link.
+ """
# only allow xlsx downloads from disseminated submissions
get_object_or_404(General, report_id=report_id)
@@ -225,10 +283,51 @@ def get(self, request, report_id, file_type):
return redirect(get_download_url(filename))
-class SummaryReportDownloadView(ReportAccessRequiredMixin, View):
+class SingleSummaryReportDownloadView(ReportAccessRequiredMixin, View):
def get(self, request, report_id):
+ """
+ Given a report_id in the URL, generate the summary report in S3 and
+ redirect to its download link.
+ """
sac = get_object_or_404(General, report_id=report_id)
filename = generate_summary_report([sac.report_id])
download_url = get_download_url(filename)
return redirect(download_url)
+
+
+class MultipleSummaryReportDownloadView(View):
+ def post(self, request):
+ """
+ 1. Run a fresh search with the provided search parameters
+ 2. Get the report_id's from the search
+ 3. Generate a summary report with the report_ids, which goes into into S3
+ 4. Redirect to the download url of this new report
+ """
+ form = SearchForm(request.POST)
+
+ try:
+ cleaned_data = clean_form_data(form)
+ include_private = include_private_results(request)
+ results = run_search_general(cleaned_data, include_private)
+ results = results[:SUMMARY_REPORT_DOWNLOAD_LIMIT] # Hard limit XLSX size
+
+ if len(results) == 0:
+ raise Http404("Cannot generate summary report. No results found.")
+ report_ids = [result.report_id for result in results]
+
+ filename = generate_summary_report(report_ids)
+ download_url = get_download_url(filename)
+
+ return redirect(download_url)
+
+ except Http404 as err:
+ logger.info(
+ "No results found for MultipleSummaryReportDownloadView post. Suggests an improper or old form submission."
+ )
+ raise Http404 from err
+ except Exception as err:
+ logger.info(
+ "Enexpected error in MultipleSummaryReportDownloadView post:\n%s", err
+ )
+ raise BadRequest(err)