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.

Sign up for GitHub

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

Jump to bottom

Remove logged warnings for maintenance mode check #4396

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Remove logged warnings for maintenance mode check #4396

merged 1 commit into from
Oct 17, 2024

Conversation

rnovak338
Copy link
Contributor

Every time a request hits the app, a MAINTENANCE_MODE S3 warning is thrown when it is off. This is going to flood the logs with a not-so-needed warning. This PR removes that.

How to test

Simply run the app and hit any request. You should NOT see a warning in the terminal for the Django server. You can confirm this is working by setting show_warning=True on file_exists() in the is_maintenance_on() routine.

PR Checklist: Submitter

  • 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.
  • Ensure that prior to merging, the working branch is up to date with main and the terraform plan is what you expect.

PR Checklist: Reviewer

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

Pre Merge Checklist: Merger

  • Ensure that prior to approving, the terraform plan is what we expect it to be. -/+ resource "null_resource" "cors_header" should be destroying and recreating its self and ~ resource "cloudfoundry_app" "clamav_api" might be updating its sha256 for the fac-file-scanner and fac-av-${ENV} by default.
  • Ensure that the branch is up to date with main.
  • Ensure that a terraform plan has been recently generated for the pull request.

@rnovak338
Remove logged warnings for maintenance mode check
603d9c8 
Every time a request hits the app, a `MAINTENANCE_MODE` S3 warning is thrown when it is off. This is going to flood the logs with a not-so-needed warning.
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 17, 2024 •
edited
Loading

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 17, 2024 •
edited
Loading

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-10-16T18:30: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 applied in Deploy to Development and Management Environment #846

@rnovak338 rnovak338 marked this pull request as ready for review October 17, 2024 20:04
@github-actions GitHub Actions
Copy link
Contributor

Code Coverage

Package Line Rate Branch Rate Health
. 100% 100% ✔
api 98% 90% ✔
audit 97% 87% ✔
audit.cross_validation 98% 86% ✔
audit.fixtures 84% 50% ❌
audit.intakelib 90% 81% ➖
audit.intakelib.checks 95% 88% ✔
audit.intakelib.common 98% 82% ✔
audit.intakelib.transforms 99% 94% ✔
audit.management.commands 78% 17% ❌
audit.migrations 100% 100% ✔
audit.models 93% 75% ➖
audit.templatetags 100% 100% ✔
audit.views 61% 39% ❌
census_historical_migration 96% 65% ✔
census_historical_migration.migrations 100% 100% ✔
census_historical_migration.sac_general_lib 92% 84% ➖
census_historical_migration.transforms 95% 90% ✔
census_historical_migration.workbooklib 68% 69% ❌
config 78% 17% ❌
curation 100% 100% ✔
curation.curationlib 57% 100% ❌
curation.migrations 100% 100% ✔
dissemination 91% 72% ➖
dissemination.migrations 97% 25% ✔
dissemination.searchlib 74% 64% ❌
dissemination.templatetags 100% 100% ✔
djangooidc 53% 38% ❌
djangooidc.tests 100% 94% ✔
report_submission 93% 88% ➖
report_submission.migrations 100% 100% ✔
report_submission.templatetags 74% 100% ❌
support 95% 78% ✔
support.management.commands 96% 100% ✔
support.migrations 100% 100% ✔
support.models 97% 83% ✔
tools 98% 50% ✔
users 98% 100% ✔
users.fixtures 100% 83% ✔
users.management 100% 100% ✔
users.management.commands 100% 100% ✔
users.migrations 100% 100% ✔
Summary 91% (17158 / 18899) 77% (2120 / 2760) ➖

@rnovak338 rnovak338 added this pull request to the merge queue Oct 17, 2024
Merged via the queue into main with commit a72e525 Oct 17, 2024
15 checks passed
@rnovak338 rnovak338 deleted the rnovak/hide-maintenance-mode-s3-warning branch October 17, 2024 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jperson1 jperson1 jperson1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rnovak338 @jperson1