248 start report

[pbastia]

An API endpoint on POST /api/reporting/reports

Card: bcgov/cas-reporting#248

Models created:

• Report
• ReportOperation (for admin operation/operator data for a report)
• ReportFacility (for individual admin facility data for a report)
• ReportingYear (To enforce FK validation for each reporting year, and store metadata associated like reporting windows and program deadlines)

Services

• ReportingService with a method to create a report object and pre-populate operation and facility data
• ReportingDataAccessService to handle database queries about reports

API routes

• POST: /api/reporting/reports creates a report with the above mentioned service and return its ID

[joshgamache]

Tests pass and the reports endpoint shows up in Django Ninja with everything as expected.

Everything looks solid! 🌮

[Sepehr-Sobhani]

🤩

[Sepehr-Sobhani]

nit: we could still keep *args, **kwargs and have something like:

    if "type" not in kwargs:
        kwargs["type"] = cycle(["sfo", "lfo"])

[pbastia]

*args makes little sense as the model baker doesn't take positional arguments

[Sepehr-Sobhani]

We have a helper class named TestUtils in utils/helpers.py customized for testing endpoints; Could be useful.

[pbastia]

This class is going to see heavy refactor when we add authentication and everything else, so we'll make sure to refactor at that time

[Sepehr-Sobhani]

nit: To avoid having to refactor this later, as we did in the registration app, I recommend breaking this into separate functions now. like def _create_report_facilities and def _create_report_operation and ...