Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Approach for changing old-format report_ids to new format #2376

Merged
merged 6 commits into from
Oct 4, 2023

Conversation

tadhg-ohiggins
Copy link
Contributor

Bad report_ids
Contaminate the DB—
Force them to conform.


As part of #2327, change the existing in-DB report_id values to conform to #2326.

The best way to test this locally is if you have old-format report_ids in your local environment and you can see them get changed to the new format after checking out this branch and running the Django management command.


Components:

  • New Django management command, update_oldformat_reportids, which does what it says and also writes a record of the changes to a text file. This is fragile, but probably enough for our purposes.
  • Changes to the cloud.gov .profile to run this command on startup.
  • An override in SingleAuditChecklist.save to allow us to make this change without running into LateChangeError.

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 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.
  • 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.

@tadhg-ohiggins tadhg-ohiggins temporarily deployed to dev October 4, 2023 00:13 — with GitHub Actions Inactive
@tadhg-ohiggins tadhg-ohiggins temporarily deployed to meta October 4, 2023 00:13 — with GitHub Actions Inactive
@tadhg-ohiggins tadhg-ohiggins requested a review from jadudm October 4, 2023 00:14
@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2023

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 applied in Deploy to Development and Management Environment #259

@tadhg-ohiggins
Copy link
Contributor Author

We tested this locally and on a subset of records on dev and it appeared to do what we expected.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2023

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.database.cloudfoundry_service_instance.rds,
  on /tmp/terraform-data-dir/modules/dev.database/database/main.tf line 14, in resource "cloudfoundry_service_instance" "rds":
  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 2 more similar warnings elsewhere)

✅ Plan applied in Deploy to Development and Management Environment #259

@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2023

File Coverage Missing
All files 88%
api/serializers.py 90% 125-126 131 136
api/test_views.py 96% 105
api/uei.py 96% 17-18 107-108
api/views.py 97% 196-197 204-205 226 362-363
audit/excel.py 85% 402 418 424 429 434 456-457 469 546 548 550 552 554 710-711 720-726 736 756
audit/forms.py 47% 22-29 142-149
audit/intake_to_dissemination.py 92% 67-68 197-203 253
audit/models.py 84% 57 59 64 66 214 247 418 436-437 445 467 543-544 548 556 565 571 574-580
audit/test_commands.py 87%
audit/test_mixins.py 90% 112-113 117-119 184-185 189-191
audit/test_validators.py 95% 436 440 608-609 848 855 862 869
audit/utils.py 76% 13 21 38
audit/validators.py 96% 287-288 303-304 514-523
audit/views.py 42% 87-108 131-132 206-207 252-253 264-265 267-271 318-331 334-348 353-366 383-389 394-414 441-445 450-479 522-526 531-551 578-582 587-616 659-663 668-680 683-693 698-710 737-738 743-792 795-835 838-855
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 69
audit/cross_validation/naming.py 68% 178-182
audit/cross_validation/submission_progress_check.py 85% 62 77-80
audit/cross_validation/tribal_data_sharing_consent.py 81% 33 36 40
audit/cross_validation/validate_general_information.py 93% 28-29
audit/fixtures/single_audit_checklist.py 79% 156 232-241
audit/management/commands/load_fixtures.py 46% 39-45
audit/viewlib/submission_progress_view.py 89% 111 171-172
audit/viewlib/tribal_data_consent.py 34% 23-41 44-79
audit/viewlib/upload_report_view.py 30% 32-35 44 91-115 118-186
cms/views.py 57% 11-16 29-30
config/urls.py 71% 87
dissemination/migrations/0002_general_fac_accepted_date.py 47% 10-12
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 80% 22 43 114
djangooidc/tests/common.py 96%
report_submission/forms.py 92% 35
report_submission/views.py 76% 83 215-216 218 240-241 260-261 287-396 399-409
report_submission/templatetags/get_attr.py 76% 8 11-14 18
support/admin.py 49% 9-10 13 34 37 74 77 82 89-95 98-100 103-104 107-108
support/cog_over.py 90% 30-33 86 93 145
support/signals.py 66% 23-24 31-32
support/test_cog_over.py 98% 134-135 224
support/management/commands/seed_cog_baseline.py 98% 20-21
tools/update_program_data.py 89% 96
users/auth.py 95% 40-41
users/fixtures/user_fixtures.py 91%

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against 5a53adb

The old parameter has been deprecated, and there appears to be stronger requirements for a URL, not just a hostname, for the endpoint value.
The newer argument referred to in the deprecation warning (`endpoints.s3`) is not being accepted. So we'll go back to just specifying `endpoint`, but give it a URL instead of just a hostname for the endpoint.
@mogul mogul temporarily deployed to dev October 4, 2023 19:35 — with GitHub Actions Inactive
@mogul mogul temporarily deployed to meta October 4, 2023 19:35 — with GitHub Actions Inactive
This file populates the necessary Terraform config for local development (an alternative to the GHA workflow, which supplies the backend vars as secrets). This change accounts for the stricter checking on the `endpoint`, which should be a URL rather than a hostname; see the previous commit for more context.
@mogul mogul requested a review from a team as a code owner October 4, 2023 19:39
@mogul mogul temporarily deployed to meta October 4, 2023 19:39 — with GitHub Actions Inactive
@mogul mogul temporarily deployed to dev October 4, 2023 19:39 — with GitHub Actions Inactive
Similar to previous commits: We have to provide a URL here, since Terraform got stricter about the value it wants for "endpoint". This commit is for the workflow used during the actual deployment.
@mogul mogul temporarily deployed to dev October 4, 2023 19:46 — with GitHub Actions Inactive
@mogul mogul temporarily deployed to meta October 4, 2023 19:46 — with GitHub Actions Inactive
Copy link
Contributor

@danswick danswick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mogul your terraform changes look good to me. Thanks for your help!

@danswick danswick added this pull request to the merge queue Oct 4, 2023
Merged via the queue into main with commit 5f6d265 Oct 4, 2023
14 checks passed
@danswick danswick deleted the tadhg/hotfix-report-id-in-place branch October 4, 2023 20:02
danswick added a commit that referenced this pull request Oct 4, 2023
)

* Approach for changing old-format report_ids to new format.

* Change data_source.

* Configure Terraform's s3 backend endpoint with a URL

The old parameter has been deprecated, and there appears to be stronger requirements for a URL, not just a hostname, for the endpoint value.

* Second try at giving the Terraform S3 backend a URL endpoint

The newer argument referred to in the deprecation warning (`endpoints.s3`) is not being accepted. So we'll go back to just specifying `endpoint`, but give it a URL instead of just a hostname for the endpoint.

* Propagate S3 backend endpoint URL change to local config

This file populates the necessary Terraform config for local development (an alternative to the GHA workflow, which supplies the backend vars as secrets). This change accounts for the stricter checking on the `endpoint`, which should be a URL rather than a hostname; see the previous commit for more context.

* Provide URL for s3 backend endpoint during Terraform apply

Similar to previous commits: We have to provide a URL here, since Terraform got stricter about the value it wants for "endpoint". This commit is for the workflow used during the actual deployment.

---------

Co-authored-by: Tadhg O'Higgins <2626258+tadhg-ohiggins@users.noreply.github.com>
Co-authored-by: Bret Mogilefsky <bret.mogilefsky@gsa.gov>
asteel-gsa pushed a commit that referenced this pull request Oct 5, 2023
* Approach for changing old-format report_ids to new format.

* Change data_source.

* Configure Terraform's s3 backend endpoint with a URL

The old parameter has been deprecated, and there appears to be stronger requirements for a URL, not just a hostname, for the endpoint value.

* Second try at giving the Terraform S3 backend a URL endpoint

The newer argument referred to in the deprecation warning (`endpoints.s3`) is not being accepted. So we'll go back to just specifying `endpoint`, but give it a URL instead of just a hostname for the endpoint.

* Propagate S3 backend endpoint URL change to local config

This file populates the necessary Terraform config for local development (an alternative to the GHA workflow, which supplies the backend vars as secrets). This change accounts for the stricter checking on the `endpoint`, which should be a URL rather than a hostname; see the previous commit for more context.

* Provide URL for s3 backend endpoint during Terraform apply

Similar to previous commits: We have to provide a URL here, since Terraform got stricter about the value it wants for "endpoint". This commit is for the workflow used during the actual deployment.

---------

Co-authored-by: Bret Mogilefsky <bret.mogilefsky@gsa.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants