Fix windows encoding issues

[peternied]

Description

Fix windows encoding issues

Adds spotbugs [1] to detect internationalization before they are added to the codebase, also fixed several encoding bugs that impact windows users.

[1] https://spotbugs.readthedocs.io/en/stable/index.html

Issues Resolved

• Resolves [Windows] Configuration values are improperly decoded #2194

Check List

• New functionality includes testing
• New functionality has been documented
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.

Project coverage is 61.11%. Comparing base (a57fd0a) to head (747e962).
Report is 722 commits behind head on main.

Files with missing lines	Patch %	Lines
...dlic/auth/http/saml/AuthTokenProcessorHandler.java	0.00%	1 Missing ⚠️
...a/org/opensearch/security/tools/SecurityAdmin.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2206      +/-   ##
============================================
+ Coverage     61.05%   61.11%   +0.06%     
  Complexity     3270     3270              
============================================
  Files           259      259              
  Lines         18335    18335              
  Branches       3248     3248              
============================================
+ Hits          11194    11206      +12     
+ Misses         5555     5542      -13     
- Partials       1586     1587       +1     

Files with missing lines	Coverage Δ
...earch/security/auditlog/impl/AbstractAuditLog.java	73.75% <100.00%> (ø)
...ty/configuration/ConfigurationLoaderSecurity7.java	70.43% <100.00%> (ø)
...ensearch/security/ssl/DefaultSecurityKeyStore.java	67.83% <100.00%> (ø)
.../org/opensearch/security/support/ConfigHelper.java	86.00% <100.00%> (ø)
...dlic/auth/http/saml/AuthTokenProcessorHandler.java	47.28% <0.00%> (ø)
...a/org/opensearch/security/tools/SecurityAdmin.java	36.60% <0.00%> (ø)

... and 7 files with indirect coverage changes

[stephen-crawford]

Do you think this should be added as a separate PR or is fine to include it in this one even though it seems not directly related to the parsing issue--maybe it is and I am wrong?

[cwperks]

This is helpful to find instances where the code is relying on the default encoding. See https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html?highlight=i18n#dm-reliance-on-default-encoding-dm-default-encoding

[peternied]

I did not add more rules because we are in violation of many different rules, but I didn't see any types that would create platform specific issues.

If you'd like to see the full list, delete line 3 and run the gradle task, you'll see hundreds of things!

[peternied]

@cwperks @DarshitChanpura Ready for review, thanks!

[peternied]

@opensearch-project/security Can I get another review on this please?

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-2206-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a040b86a48eebcbe2791ba6371772fb9d386d6f2
# Push it to GitHub
git push --set-upstream origin backport/backport-2206-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-2206-to-2.x.

[opensearch-trigger-bot]

The backport to 2.4 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.4 2.4
# Navigate to the new working tree
cd .worktrees/backport-2.4
# Create a new branch
git switch --create backport/backport-2206-to-2.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a040b86a48eebcbe2791ba6371772fb9d386d6f2
# Push it to GitHub
git push --set-upstream origin backport/backport-2206-to-2.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.4

Then, create a pull request where the base branch is 2.4 and the compare/head branch is backport/backport-2206-to-2.4.

[peternied]

Manual backports created:

• [Backport 2.x] Fix windows encoding issues (#2206) #2217
• [Backport 2.4] Fix windows encoding issues (#2206) #2218

[opensearch-trigger-bot]

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.3 1.3
# Navigate to the new working tree
cd .worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-2206-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a040b86a48eebcbe2791ba6371772fb9d386d6f2
# Push it to GitHub
git push --set-upstream origin backport/backport-2206-to-1.3
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-2206-to-1.3.