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

Add Cross Validation for total_amount_expended < DOLLAR_THRESHOLD #4128

Closed
wants to merge 2 commits into from

Conversation

jperson1
Copy link
Contributor

@jperson1 jperson1 commented Jul 29, 2024

Add Cross Validation for total_amount_expended < DOLLAR_THRESHOLD

Issue: closes #3869

Changes:

Add check_total_amount_expended to the cross validation functions.

  1. The actual function is in its own file
  2. The error message references the UG and is included in errors.py
  3. It is included in init to ensure it runs with the rest
  4. A test file covers a few cases for total_amount_expended - at, above, or below the threshold

How to test:

  1. Switch to this branch and run normally
  2. Go through the submission process with a federal awards workbook with a too-low total_amount_expended
    • I edited the test workbook that Cypress uses to have $200 of awards total. That way the other workbooks are still usable.
  3. Walk it through to cross validation
  4. Ensure that the correct error message displays at the time of cross validation

Screenshots:

The error message:
image

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.

Copy link
Contributor

github-actions bot commented Jul 29, 2024

Terraform plan for dev

Plan: 1 to add, 0 to change, 1 to destroy.
Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
-/+ destroy and then create replacement

Terraform will perform the following actions:

  # module.dev.module.cors.null_resource.cors_header must be replaced
-/+ resource "null_resource" "cors_header" {
!~      id       = "******************" -> (known after apply)
!~      triggers = { # forces replacement
!~          "always_run" = "2024-07-29T18:02:36Z" -> (known after apply)
        }
    }

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

Warning: Argument is deprecated

  with module.dev-backups-bucket.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/dev-backups-bucket/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 6 more similar warnings elsewhere)

📝 Plan generated in Pull Request Checks #3390

Copy link
Contributor

github-actions bot commented Jul 29, 2024

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 #3390

Copy link
Contributor

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
18079 16523 91% 0% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 7891df7 by action🐍

@jperson1 jperson1 requested a review from a team July 30, 2024 17:43
@jperson1 jperson1 marked this pull request as ready for review July 30, 2024 17:43
Copy link
Contributor

@sambodeme sambodeme left a comment

Choose a reason for hiding this comment

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

I suggest moving this to intakelib/checks instead. The reasoning behind cross-validation is that these validations perform checks involving more than a single section. In this case, all the information needed to perform the validation is available at intake time and only requires the federal award workbook, so it is more appropriate to perform the validation right when the workbook is being submitted. We also have a few checks in cross-validation, including check_award_ref_existence, check_award_reference_uniqueness, and check_finding_reference_uniqueness, that we will want to move into intakelib/checks due to the nature of their checks, but that is beyond the scope of this PR.

@jperson1
Copy link
Contributor Author

Closing this as superseded by 4198. The code can/will remain for reference, but it makes more sense to implement this when we have multiple thresholds to validate for.

@jperson1 jperson1 closed this Aug 29, 2024
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.

Add cross-validation for total_amount_expended < limit
3 participants