Issue 571: Require completion of a survey before yearly allowance may be renewed

[haudquaquam]

Fixes #571

Changes

• Added a JSON field, renewal_survey_answers to AllocationRenewalRequest model to store survey responses. Default value is an empty dict.
• Introduced a new renewal form, ProjectRenewalSurveyForm (modeled after SavioProjectSurveyForm):
  • Checks for BRC_ONLY or LRC_ONLY flag at runtime to determine which questions to display. BRC and LRC will use different survey questions.
  • Current questions are placeholders and should be updated accordingly.
  • Added template project_renewal_survey.html, modeled after new_project_survey.html.
  • Imported the form and template into the two views through which a user can request an allocation renewal: AllocationRenewalRequestUnderProjectView and AllocationRenewalRequestView in renewal_views/request_views.py.

How to Test

• Manual Testing
  • As a user who is on a project, go to the project's detail page -> Renew Allowance, or go to Project -> Projects -> Renew a PI's Allowance.
  • Complete the renewal request flow, and ensure the survey is there and has the desired questions depending on if the deployment is LRC or BRC.
  • After submitting the renewal request, go to the Coldfront Administration dashboard and view the newly created Allocation Renewal Request object. Survey answers should appear in JSON format under Renewal survey answers.

[matthew-li]

Thanks, code changes so far LGTM. I'll take a closer look when the actual survey has been integrated.

(Reminder to add a popup to the renewal request detail view, showing the answers.)

[haudquaquam]

Changes

• Added BRC survey questions that will be used for the upcoming allocation renewal request period.
• Added subcommand renewal_survey_responses to export_data command:
  • Changed original survey_responses to new_project_responses
  • renewal_survey_responses is a subcommand that will print the responses of AllocationRenewalRequest renewal survey responses given a format and allocation period.
  • Raises an exception if the given allocation period does not have a required survey (this is done by checking if any of the surveys of the AllocationRenewalRequest objects within a certain allocation_period are empty).
  • Requires allocation_period flag where user specifies the period (i.e. 'Allowance Year 2024 - 2025').
  • Prints out human-readable question and answer names instead of default form IDs.

How to Test

• Manual Testing
  • Create an AllocationRenewalRequest with the corresponding survey answers under the 2024-2025 allowance year (since the previous years did not have required renewal forms.)
  • Run python3 manage.py export_data renewal_survey_responses --allocation_period 'Allowance Year 2024 - 2025' --format json
  • Change format to csv and ensure that it displays properly as well.
  • Try earlier allocation periods (i.e. 'Allowance Year 2023 - 2024') to make sure that the proper exception is thrown, indicating that allocation periods earlier than 2024 - 2025 did not have required renewal surveys.

[haudquaquam]

Changes

• Made several small changes based on @matthew-li's comments (i.e. grouping imports, removing leftover debugging code, renaming variables, tweaking BRC renewal survey questions).
• export_data renewal survey responses function:
  • Fixed bugs covering empty answers and list index out of bounds for invalid allocation periods.
  • Extracted logic for swapping answer IDs for plain-text into _swap_form_answer_id_for_text.
• Added steps in allocation renewal request tests to fill in the renewal survey.

[matthew-li]

Changes:

• Got rid of the merge migration.
• Added temporary logic to ensure that the survey form only appears for "Allowance Year 2024 - 2025". This will need to be updated before the subsequent period.
• Added tests for the above logic.
• Updated the app-base Docker image to install libfaketime, which can be used to mock a date/time by setting some environment variables.