Make section names constants

[tadhg-ohiggins]

Naming things is hard—
Metaclasses for the win.
Now names are constants.

---

Add an NC class to audit/cross_validation/naming.py that has class-level read-only attributes storing the canonical snake-case section names.

This makes it possible to use e.g. NC.GENERAL_INFORMATION instead of the string "general_information".

This PR uses that class in audit/cross_validation/submission_progress_check.py instead of strings.

NC has a deliberately short name so as to make the switch from strings to using it relatively painless and only add one character to line length.

This PR only uses NC in a very limited number of places, so this shouldn’t change anything. No features should change, so local test runs and code review should be sufficient.

Uses metaclass wrangling to set up a class that has read-only class-level attributes containing the all_caps section names, each of which has the corresponding snake_case as its value.

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.

[github-actions]

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

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

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

[github-actions]

File	Coverage		Missing
All files	88%	❌
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 846 853 860 867
audit/utils.py	92%	✅	12
audit/validators.py	96%	✅	253-254 282-283 298-299 309 500-509
audit/views.py	37%	❌	85-106 129-130 192-193 236-237 247-258 299-312 315-329 334-347 361-367 372-392 419-423 428-457 497-501 506-526 553-557 562-591 631-635 640-652 655-666 671-683 696-697 702-751 754-791 794-811
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/naming.py	68%	❌	178-182
audit/cross_validation/submission_progress_check.py	82%	❌	62 77-80
audit/cross_validation/tribal_data_sharing_consent.py	86%	❌	20
audit/fixtures/single_audit_checklist.py	79%	❌	155 231-240
audit/management/commands/load_fixtures.py	46%	❌	39-45
audit/viewlib/submission_progress_view.py	96%	✅	158-159
audit/viewlib/upload_report_view.py	30%	❌	31-34 43 90-114 117-182
cms/views.py	57%	❌	11-16 29-30
config/urls.py	71%	❌	87
dissemination/models.py	99%	✅	685
djangooidc/backends.py	78%	❌	32 57-63
djangooidc/exceptions.py	66%	❌	19 21 23 28
djangooidc/oidc.py	15%	❌	32-35 45-51 64-70 78-84 92-149 153-199 203-226 230-275 280-281
djangooidc/views.py	78%	❌	23-26 43 114
djangooidc/tests/common.py	96%	✅
report_submission/forms.py	90%	✅	9
report_submission/views.py	72%	❌	82 191-193 195 201-308 311-321
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 a961b0c

[jadudm]

Looks good. Walked this with the author, and @jperson1 is doing a local run and check before merge. I'll leave merge to @jperson1 .

[jperson1]

Looks good! All tests passing, manual check is good, and no conflicts following a merge with main.