DRAFT - WIP - POM for Search Page + Cypress tests

[eazapata23]

This PR is linked to #3485
This PR will close #3590
This PR will close #3591

In this PR:

• I added a plugin downloadFile for cypress and added it as a task in cypress.config.js
• Under support in Cypress directory, in the commands.js file the line require(cypress-downloadfile) was added.
• Cypress-downloadfile was added to package-lock.json & package.json
• Added search-tests.cy.js to e2e, which has two tests 1) basic search test & 2) advance search test
• Added data for search page to fixtures under search_page_data this holds all data for search parameters in one single json file vs before where I originally separated each field into it's own separate json files.
• I created a page_objects folder w/ file search-page.js this holds all web elements for search page + summary report and method/functions for interacting with web element.
• POM for gen-info added to Page Objects + deleted old gen-info cypress test.
• I modified the login-gov.js to include an if else statement due to the fact that login.gov started to ask if you wanted to add your PIV card as an authentication, I added the if else to skip this step.
• I modified the initialize-audit.js to import from the page_objects folder.
• I added check-access.js to the page_objects folder and deleted it from the support folder.
• I also added some new dependencies to both the package-lock.json & package.json.

How to test:

1. Pull this branch, now since we're using a plugin for cypress, we need to make sure to download it locally on our machine or the tests won't work for search. Make sure you're on the backend directory of the project and run npm i --save-dev cypress-downloadfile. Once installed, you should see in your IDE a new folder titled downloads appear in the cypress directory, it should appear just under cypress but before e2e.

2. Run docker as you normally would and once docker is running on another tab run this command docker compose exec web /bin/bash this will get you into docker shell. After that, run this command python manage.py materialized_views --create . (I had to do this since I didn't have materialized view and my search tests would fail but after running command they passed)

3. Now in your terminal, enter your cypress env variables and run npx cypress open

4. Once cypress is open, run the full-submission.cy.js tests should pass may take one or two tries for them but once they are completed run the other test for search-tests.cy.js -- Side
   Note: BEFORE running search tests, you'll notice that in your cypress downloads folder you won't have anything in there but AFTER running search tests, a sf-sac-summary-report.xlsx and/or a single-audit-report.pdf will show up, indicating that the download did work.

Before Running Search Tests:

5. Now once you run search-tests.cy.js you should able to run a basic search that populates results, selecting a an audit from the table and viewing your summary report and downloading each document successfully.

Screen.Recording.2024-04-04.at.12.31.18.PM.mov

After Running Search Tests:

6. The same applies for testing advance search fields but these are commented out for now since basic search returns results.

7. You can also verify search results with dbeaver by checking in Materialized Views:

PR checklist: submitters

• Link to an issue if possible. If there’s no issue, describe what your branch does. Even if there is an issue, a brief description in the PR is still useful.
• List any special steps reviewers have to follow to test the PR. For example, adding a local environment variable, creating a local test file, etc.
• For extra credit, submit a screen recording like this one.
• Make sure you’ve merged main into your branch shortly before creating the PR. (You should also be merging main into your branch regularly during development.)
• Make sure you’ve accounted for any migrations. When you’re about to create the PR, bring up the application locally and then run git status | grep migrations. If there are any results, you probably need to add them to the branch for the PR. Your PR should have only one new migration file for each of the component apps, except in rare circumstances; you may need to delete some and re-run python manage.py makemigrations to reduce the number to one. (Also, unless in exceptional circumstances, your PR should not delete any migration files.)
• Make sure that whatever feature you’re adding has tests that cover the feature. This includes test coverage to make sure that the previous workflow still works, if applicable.
• Make sure the full-submission.cy.js Cypress test passes, if applicable.
• Do manual testing locally. Our tests are not good enough yet to allow us to skip this step. If that’s not applicable for some reason, check this box.
• Verify that no Git surgery was necessary, or, if it was necessary at any point, repeat the testing after it’s finished.
• Once a PR is merged, keep an eye on it until it’s deployed to dev, and do enough testing on dev to verify that it deployed successfully, the feature works as expected, and the happy path for the broad feature area (such as submission) still works.

PR checklist: reviewers

• Pull the branch to your local environment and run make docker-clean; make docker-first-run && docker compose up; then run docker compose exec web /bin/bash -c "python manage.py test"
• Manually test out the changes locally, or check this box to verify that it wasn’t applicable in this case.
• Check that the PR has appropriate tests. Look out for changes in HTML/JS/JSON Schema logic that may need to be captured in Python tests even though the logic isn’t in Python.
• Verify that no Git surgery is necessary at any point (such as during a merge party), or, if it was, repeat the testing after it’s finished.

The larger the PR, the stricter we should be about these points.

[github-actions]

Terraform plan for meta

No changes. Your infrastructure matches the configuration.

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration
and found no differences, so no changes are needed.

Warning: Argument is deprecated

  with module.s3-backups.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/s3-backups/s3/main.tf line 14, in resource "cloudfoundry_service_instance" "bucket":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

📝 Plan generated in Pull Request Checks #2838

[github-actions]

Terraform plan for dev

No changes. Your infrastructure matches the configuration.

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration
and found no differences, so no changes are needed.

Warning: Argument is deprecated

  with module.dev.module.cg-logshipper.module.s3-logshipper-storage.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/dev.cg-logshipper.s3-logshipper-storage/s3/main.tf line 14, in resource "cloudfoundry_service_instance" "bucket":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

(and 3 more similar warnings elsewhere)

📝 Plan generated in Pull Request Checks #2838

[github-actions]

File	Coverage		Missing
All files	88%	✅
api/serializers.py	88%	✅	177-178 183 188
api/test_views.py	95%	✅	103
api/uei.py	88%	✅	87 118-119 163 167-168
api/views.py	98%	✅	198-199 337-338
audit/forms.py	60%	❌	31-38 109-116
audit/intake_to_dissemination.py	88%	✅	57-62 264 308-316
audit/mixins.py	96%	✅	27
audit/test_commands.py	91%	✅
audit/test_intakelib.py	88%	✅	154-158
audit/test_manage_submission_access_view.py	98%	✅	15 19
audit/test_mixins.py	90%	✅	159-160 164-166 254-255 259-261
audit/test_validators.py	95%	✅	439 443 611-612 851 858 865 872 1107-1108 1139-1140 1165-1170
audit/test_views.py	98%	✅	132
audit/test_workbooks_should_fail.py	88%	✅	58 87-88 92
audit/test_workbooks_should_pass.py	87%	✅	59 74-76
audit/utils.py	91%	✅	33-35 38
audit/validators.py	93%	✅	138 190 378-379 394-395 478-479 581-585 590-594 610-619
audit/cross_validation/additional_ueis.py	93%	✅	33
audit/cross_validation/check_award_ref_declaration.py	90%	✅
audit/cross_validation/check_award_reference_uniqueness.py	93%	✅
audit/cross_validation/check_certifying_contacts.py	87%	✅
audit/cross_validation/check_findings_count_consistency.py	91%	✅
audit/cross_validation/check_ref_number_in_cap.py	90%	✅
audit/cross_validation/check_ref_number_in_findings_text.py	90%	✅
audit/cross_validation/errors.py	78%	❌	30 77
audit/cross_validation/naming.py	93%	✅	197
audit/cross_validation/submission_progress_check.py	95%	✅	80
audit/cross_validation/tribal_data_sharing_consent.py	81%	❌	33 36 40
audit/cross_validation/validate_general_information.py	64%	❌	72 76-79 91 94
audit/fixtures/single_audit_checklist.py	55%	❌	147-184 230-239
audit/intakelib/exceptions.py	71%	❌	7-9 12
audit/intakelib/intermediate_representation.py	91%	✅	27-28 73 91 129 200-203 212-213 283-284
audit/intakelib/mapping_audit_findings.py	97%	✅	55
audit/intakelib/mapping_audit_findings_text.py	97%	✅	54
audit/intakelib/mapping_federal_awards.py	93%	✅	92
audit/intakelib/mapping_util.py	79%	❌	21 25 29 63 99 104-105 114-120 130 145 150
audit/intakelib/checks/check_all_unique_award_numbers.py	79%	❌	24
audit/intakelib/checks/check_cluster_names.py	75%	❌	20-25
audit/intakelib/checks/check_cluster_total.py	95%	✅	99
audit/intakelib/checks/check_has_all_the_named_ranges.py	95%	✅	66
audit/intakelib/checks/check_is_a_workbook.py	69%	❌	20
audit/intakelib/checks/check_loan_balance_entries.py	83%	❌	28
audit/intakelib/checks/check_look_for_empty_rows.py	91%	✅	18
audit/intakelib/checks/check_no_major_program_no_type.py	76%	❌	18 27
audit/intakelib/checks/check_no_repeat_findings.py	76%	❌	21 30
audit/intakelib/checks/check_other_cluster_names.py	81%	❌	23 33
audit/intakelib/checks/check_passthrough_name_when_no_direct.py	88%	✅	9 47
audit/intakelib/checks/check_sequential_award_numbers.py	82%	❌	25 35
audit/intakelib/checks/check_start_and_end_rows_of_all_columns_are_same.py	89%	✅	14
audit/intakelib/checks/check_state_cluster_names.py	81%	❌	23 33
audit/intakelib/checks/check_version_number.py	73%	❌	21 31-32
audit/intakelib/checks/runners.py	97%	✅	155
audit/intakelib/common/util.py	90%	✅	22 39
audit/intakelib/transforms/xform_rename_additional_notes_sheet.py	81%	❌	14
audit/management/commands/load_fixtures.py	46%	❌	39-45
audit/models/models.py	85%	✅	58 60 65 67 209 215 227 239-242 260 437 455-456 464 486 584-585 589 597 606 612
audit/views/audit_info_form_view.py	27%	❌	25-74 77-117 120-137
audit/views/manage_submission.py	86%	✅	73-80
audit/views/manage_submission_access.py	98%	✅	113-114
audit/views/pre_dissemination_download_view.py	78%	❌	15-16 21-22 29-39
audit/views/submission_progress_view.py	96%	✅	176-177
audit/views/tribal_data_consent.py	34%	❌	23-41 44-79
audit/views/unlock_after_certification.py	57%	❌	28-51 73-87
audit/views/upload_report_view.py	26%	❌	32-35 44 91-117 120-170 178-209
audit/views/views.py	53%	❌	74 81-100 123-124 198-199 220-230 257 268-269 280-281 283-287 329-342 345-359 364-377 394-400 405-425 452-456 461-490 533-537 542-562 589-593 598-627 670-674 679-691 694-704 709-721 754-768
census_historical_migration/change_record.py	96%	✅	30 34
census_historical_migration/test_federal_awards_xforms.py	99%	✅	208-209
census_historical_migration/sac_general_lib/audit_information.py	91%	✅	24 78
census_historical_migration/sac_general_lib/cognizant_oversight.py	68%	❌	11
census_historical_migration/sac_general_lib/general_information.py	91%	✅	150-151 159-160 204 275
census_historical_migration/sac_general_lib/sac_creator.py	90%	✅	34
census_historical_migration/sac_general_lib/utils.py	83%	❌	33 60-69
census_historical_migration/transforms/xform_retrieve_uei.py	67%	❌	10
census_historical_migration/workbooklib/additional_eins.py	84%	❌	58-60 67-77
census_historical_migration/workbooklib/additional_ueis.py	77%	❌	27-29 36-46
census_historical_migration/workbooklib/corrective_action_plan.py	81%	❌	40-42 73-89
census_historical_migration/workbooklib/excel_creation_utils.py	65%	❌	99 108-113 118-125 129-147 160-164 178-181
census_historical_migration/workbooklib/federal_awards.py	70%	❌	94-97 268 309-317 327-352 485-576
census_historical_migration/workbooklib/findings.py	27%	❌	40-45 91-111 116-136 149-151 158-179
census_historical_migration/workbooklib/findings_text.py	81%	❌	38-39 70-87
census_historical_migration/workbooklib/notes_to_sefa.py	55%	❌	34-38 101-102 104-105 107-108 135-141 149-157 165-167 172-189 196-232
config/error_handlers.py	94%	✅	22
config/test_settings.py	92%	✅	33-34 49-50
config/urls.py	72%	❌	88
dissemination/file_downloads.py	81%	❌	43-61 91-93
dissemination/forms.py	87%	✅	135 144 255
dissemination/search.py	61%	❌	101 108 110 113-121
dissemination/summary_reports.py	78%	❌	274 300-302 306-310 421 438 459 511-575 603 638-640 664-672
dissemination/test_search.py	93%	✅	51-66 473-474 579-596 608-632 644-669 677-693
dissemination/test_summary_reports.py	98%	✅
dissemination/views.py	76%	❌	134 140-142 159-223 266 296 298 332 383 385 387 465-470
dissemination/migrations/0002_general_fac_accepted_date.py	47%	❌	10-12
dissemination/searchlib/search_alns.py	37%	❌	44-58 78-110 115-177 184-187
dissemination/searchlib/search_direct_funding.py	86%	✅	21-22
dissemination/searchlib/search_findings.py	76%	❌	18-24 34 36 38
dissemination/searchlib/search_general.py	96%	✅	138
dissemination/searchlib/search_passthrough_name.py	35%	❌	21-31
djangooidc/backends.py	78%	❌	32 57-63
djangooidc/exceptions.py	66%	❌	19 21 23 28
djangooidc/oidc.py	16%	❌	32-35 45-51 64-70 92-149 153-199 203-226 230-275 280-281 286
djangooidc/views.py	81%	❌	22 43 109-110 117
djangooidc/tests/common.py	97%	✅
report_submission/forms.py	92%	✅	35
report_submission/views.py	78%	❌	86 225 249-250 255-256 296-442 445-455
report_submission/templatetags/get_attr.py	76%	❌	8 11-14 18
support/admin.py	88%	✅	76 79 84 91-97 100-102
support/cog_over.py	91%	✅	30-33 93 145
support/test_admin_api.py	81%	❌	23 147-148 237-238 317-318
support/test_cog_over.py	98%	✅	134-135 224
support/management/commands/seed_cog_baseline.py	98%	✅	20-21
support/models/cog_over.py	89%	✅	103-104
tools/update_program_data.py	89%	✅	96
users/admin.py	99%	✅	27
users/auth.py	96%	✅	58-59
users/models.py	96%	✅	18 74-75
users/fixtures/user_fixtures.py	91%	✅

Minimum allowed coverage is 85%

Generated by 🐒 cobertura-action against 821be14

[jperson1]

The tests look great! One thing for now, and two notes for Soon™.

1. We should rename the it blocks, or break them into several it's.

2. Documentation on running advanced search locally is lacking. A quick blurb on what the materialized view is and how to get it running/how it relates to search would be good. It's not terribly pertinent to this PR, however.

3. The report ID is something that will change with every run of these tests, so we'll want a good way to make sure the correct one gets pulled for use when we run these in the higher environments. Maybe an API call to grab the most recent test submissions report_id, or something like that.

[jperson1]

🎉

[eazapata23]

Needs further revision based off questions/concerns not addressed here.

[danswick]

Per discussion with @eazapata23, this branch/PR is going to be restructured a bit before landing.

[eazapata23]

This PR is now tracked and will close by PR #3574