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

Audit Info - Optional Fields JS Fixes #1877

Merged
merged 18 commits into from
Aug 22, 2023

Conversation

jperson1
Copy link
Contributor

@jperson1 jperson1 commented Aug 18, 2023

Audit Info Fixes - Optional Fields "required" and "hidden" Attributes

Issue: #1678

Changes:

  1. Rewritten event handlers for the audit info form.
    • One handler on the form wipes the optional fields if they shouldn't send data. Such as in the case a user selects the relevant checkbox, fills out the optional questions, then unchecks that box.
    • One handler on the "Not GAAP" checkbox that shows/hides the optional questions and makes them required/not required as necessary.
    • Several handlers on the optional questions so that they do not stay required if they get answered.
  2. Minor change to the audit info form schema, to make a bool a string
    • This field can be either True, False, or nothing. As a quick fix, I made it a string field where an empty string is used when the question is unanswered.

How to test:

  1. Swap to this branch and run normally.
  2. Create an audit or navigate to an existing audit, and find the audit information form
  3. Try to break it. This may include:
    • Trying to submit without filling things out
    • Trying to submit with data in the optional fields, but without the "Not GAAP" field checked
    • Changing data that's already in your DB, and ensuring it updates properly

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 Git surgery is 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.
  • 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.
  • If Git surgery is necessary at any point (such as during a merge party), repeat the testing after it’s finished.

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

@jperson1 jperson1 self-assigned this Aug 18, 2023
@jperson1 jperson1 temporarily deployed to dev August 18, 2023 19:27 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta August 18, 2023 19:27 — with GitHub Actions Inactive
@jperson1 jperson1 marked this pull request as ready for review August 18, 2023 19:27
@github-actions
Copy link
Contributor

github-actions bot commented Aug 18, 2023

Terraform plan for meta

Plan: 4 to add, 0 to change, 0 to destroy.
Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # module.environments["dev"].local_file.cf_org will be created
  + resource "local_file" "cf_org" {
      + content              = <<-EOT
            cf_org_name = "gsa-tts-oros-fac"
        EOT
      + content_base64sha256 = (known after apply)
      + content_base64sha512 = (known after apply)
      + content_md5          = (known after apply)
      + content_sha1         = (known after apply)
      + content_sha256       = (known after apply)
      + content_sha512       = (known after apply)
      + directory_permission = "0777"
      + file_permission      = "0644"
      + filename             = "./../dev/orgname.auto.tfvars"
      + id                   = (known after apply)
    }

  # module.environments["preview"].local_file.cf_org will be created
  + resource "local_file" "cf_org" {
      + content              = <<-EOT
            cf_org_name = "gsa-tts-oros-fac"
        EOT
      + content_base64sha256 = (known after apply)
      + content_base64sha512 = (known after apply)
      + content_md5          = (known after apply)
      + content_sha1         = (known after apply)
      + content_sha256       = (known after apply)
      + content_sha512       = (known after apply)
      + directory_permission = "0777"
      + file_permission      = "0644"
      + filename             = "./../preview/orgname.auto.tfvars"
      + id                   = (known after apply)
    }

  # module.environments["production"].local_file.cf_org will be created
  + resource "local_file" "cf_org" {
      + content              = <<-EOT
            cf_org_name = "gsa-tts-oros-fac"
        EOT
      + content_base64sha256 = (known after apply)
      + content_base64sha512 = (known after apply)
      + content_md5          = (known after apply)
      + content_sha1         = (known after apply)
      + content_sha256       = (known after apply)
      + content_sha512       = (known after apply)
      + directory_permission = "0777"
      + file_permission      = "0644"
      + filename             = "./../production/orgname.auto.tfvars"
      + id                   = (known after apply)
    }

  # module.environments["staging"].local_file.cf_org will be created
  + resource "local_file" "cf_org" {
      + content              = <<-EOT
            cf_org_name = "gsa-tts-oros-fac"
        EOT
      + content_base64sha256 = (known after apply)
      + content_base64sha512 = (known after apply)
      + content_md5          = (known after apply)
      + content_sha1         = (known after apply)
      + content_sha256       = (known after apply)
      + content_sha512       = (known after apply)
      + directory_permission = "0777"
      + file_permission      = "0644"
      + filename             = "./../staging/orgname.auto.tfvars"
      + id                   = (known after apply)
    }

Plan: 4 to add, 0 to change, 0 to destroy.

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

@github-actions
Copy link
Contributor

github-actions bot commented Aug 18, 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.

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

@jperson1 jperson1 marked this pull request as draft August 18, 2023 19:28
@github-actions
Copy link
Contributor

github-actions bot commented Aug 18, 2023

File Coverage Missing
All files 90%
api/serializers.py 89% 121-122 127 132
api/test_views.py 99%
api/uei.py 96% 17-18 107-108
api/views.py 97% 187-188 195-196 217 395-396
audit/cog_agency.py 94% 49
audit/cog_over.py 53% 73-116 120-136 144
audit/etl.py 78% 55-56 73-74 107 194-200 214-235 256 271 401-430
audit/excel.py 87% 397 413 419 424 429 451-452 464 665-666 675-681 691 711
audit/forms.py 56% 22-29
audit/models.py 82% 86 155 311 329-330 338 360 417-420 449-450 454 462 471 481 484-490
audit/test_commands.py 87%
audit/test_etl.py 97% 235-250 331-334
audit/test_mixins.py 90% 112-113 117-119 184-185 189-191
audit/test_validators.py 95% 434 438 606-607 845 852 859 866
audit/utils.py 92% 12
audit/validators.py 96% 253-254 282-283 298-299 309 500-509
audit/views.py 35% 80-101 124-125 187-188 231-232 242-253 294-307 310-324 329-342 356-362 367-387 414-418 423-452 492-496 501-521 548-552 557-586 626-630 635-647 650-661 666-678 691-692 770-771 776-825 828-865 868-885 890-893 898 945-965 968-1034
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_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 61
audit/cross_validation/submission_progress_check.py 88% 87 112-113
audit/cross_validation/tribal_data_sharing_consent.py 86% 20
audit/fixtures/single_audit_checklist.py 86% 155 229-235
audit/management/commands/load_fixtures.py 46% 39-44
cms/views.py 57% 11-16 29-30
dissemination/models.py 99% 685
report_submission/forms.py 90% 9
report_submission/views.py 72% 82 191-193 195 201-293 296-306
report_submission/templatetags/get_attr.py 76% 8 11-14 18
tools/update_program_data.py 89% 96
users/auth.py 95% 39-40
users/fixtures/user_fixtures.py 91%

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against b12343c

@jperson1 jperson1 temporarily deployed to dev August 18, 2023 19:51 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta August 18, 2023 19:51 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to dev August 18, 2023 19:53 — with GitHub Actions Inactive
@jperson1 jperson1 temporarily deployed to meta August 18, 2023 19:53 — with GitHub Actions Inactive
@jperson1 jperson1 marked this pull request as ready for review August 18, 2023 21:47
@jadudm jadudm temporarily deployed to meta August 21, 2023 17:18 — with GitHub Actions Inactive
@jadudm jadudm temporarily deployed to dev August 21, 2023 17:22 — with GitHub Actions Inactive
@jadudm jadudm temporarily deployed to meta August 21, 2023 17:22 — with GitHub Actions Inactive
@tadhg-ohiggins tadhg-ohiggins marked this pull request as draft August 21, 2023 17:27
@jadudm
Copy link
Contributor

jadudm commented Aug 21, 2023

if not_gaap is present, then we should have three additional fields. (The is_sp sequence.) Two are arrays/mult-choice, and one is a boolean.

If it is not present, those three fields should not be present.

#1678

@sambodeme sambodeme temporarily deployed to dev August 22, 2023 02:28 — with GitHub Actions Inactive
@sambodeme sambodeme temporarily deployed to meta August 22, 2023 02:28 — with GitHub Actions Inactive
@sambodeme sambodeme temporarily deployed to meta August 22, 2023 13:28 — with GitHub Actions Inactive
@sambodeme sambodeme temporarily deployed to dev August 22, 2023 13:28 — with GitHub Actions Inactive
@sambodeme sambodeme marked this pull request as ready for review August 22, 2023 14:11
@sambodeme sambodeme temporarily deployed to dev August 22, 2023 18:34 — with GitHub Actions Inactive
@sambodeme sambodeme temporarily deployed to meta August 22, 2023 18:34 — with GitHub Actions Inactive
@tadhg-ohiggins tadhg-ohiggins merged commit 6f35857 into main Aug 22, 2023
@tadhg-ohiggins tadhg-ohiggins deleted the jp/audit-info-required-fields branch August 22, 2023 18:45
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