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

Convert files with CRLF line endings to LF #4221

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Conversation

rnovak338
Copy link
Contributor

This is not tied to any particular issue on the FAC board but is needed for my changes to #3506. Used an extension in VSCode: Change All End Of Line Sequence to convert each of files listed in this PR to LF. After consulting with @danswick the expectation is that each of these files should have already been using LF.

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.

Used an extension in VSCode: `Change All End Of Line Sequence` to convert each of the following files to LF.
Copy link
Contributor

github-actions bot commented Aug 26, 2024

Terraform plan for dev

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

Terraform will perform the following actions:

  # module.dev.module.clamav.cloudfoundry_app.clamav_api will be updated in-place
!~  resource "cloudfoundry_app" "clamav_api" {
!~      docker_image                    = "ghcr.io/gsa-tts/fac/clamav@sha256:9f2daecce2d94248952899f82133dee8018cc0a03a7f5330b8013b69468344a4" -> "ghcr.io/gsa-tts/fac/clamav@sha256:7022b7e1822e8efb451c9cc35b4488c42aca306705654980f5a55c5ff62755b3"
        id                              = "779bbc51-f78a-4186-90eb-5acb68d7d746"
        name                            = "fac-av-dev"
#        (17 unchanged attributes hidden)

#        (1 unchanged block hidden)
    }

  # 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-08-21T18:47:13Z" -> (known after apply)
        }
    }

  # module.dev.module.file_scanner_clamav.cloudfoundry_app.clamav_api will be updated in-place
!~  resource "cloudfoundry_app" "clamav_api" {
!~      docker_image                    = "ghcr.io/gsa-tts/fac/clamav@sha256:9f2daecce2d94248952899f82133dee8018cc0a03a7f5330b8013b69468344a4" -> "ghcr.io/gsa-tts/fac/clamav@sha256:7022b7e1822e8efb451c9cc35b4488c42aca306705654980f5a55c5ff62755b3"
        id                              = "65c83416-4126-4785-99c2-5e1adb810422"
        name                            = "fac-av-dev-fs"
#        (17 unchanged attributes hidden)

#        (1 unchanged block hidden)
    }

Plan: 1 to add, 2 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 #783

Copy link
Contributor

github-actions bot commented Aug 26, 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 applied in Deploy to Development and Management Environment #783

@rnovak338 rnovak338 changed the title Convert files ending in CRLF to LF Convert files with CRLF line endings to LF Aug 26, 2024
Copy link
Contributor

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
18216 16616 91% 0% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 23214c3 by action🐍

@asteel-gsa
Copy link
Contributor

Feel free to deploy this to preview, so long as @sambodeme is not actively testing with previews current code base and make sure the CRLF -> LF fixes deploy and operate as we expect.

Doubt there will be any issue at all, but better safe than sorry

Copy link
Contributor

@jperson1 jperson1 left a comment

Choose a reason for hiding this comment

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

I deployed the branch to preview here. No errors, and a casual spot check of the site looks good!

EDIT: Oh, and the code looks good too. Git should find a way to handle this that doesn't involve super bloated change records, but what are you gonna do?

@rnovak338
Copy link
Contributor Author

Thank you @jperson1! I sanity checked this on preview as well and don't seem to have any trouble. I will move this forward.

@rnovak338 rnovak338 added this pull request to the merge queue Aug 27, 2024
Merged via the queue into main with commit 2a16a0d Aug 27, 2024
19 checks passed
@rnovak338 rnovak338 deleted the rnovak/update-crlf-to-lf branch August 27, 2024 20:46
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.

3 participants