Introduce source code linting to CAM-SIMA Fortran CI

[kuanchihwang]

Tag name

None (Bit-for-bit)

Originator(s)

kuanchihwang

Description (include the issue title, and the keyword ['closes', 'fixes', 'resolves'] followed by the issue number)

This PR introduces source code linting via Fortitude to the CAM-SIMA Fortran CI pipeline. The Fortitude configuration is located at test/fortitude.toml.

Running fortitude --config-file ./test/fortitude.toml check ./src currently generates 40000+ linter errors in the CAM-SIMA codebase. While many of them are stylistic, others reveal real code quality concerns related to correctness, modernization, and portability.

To avoid bombarding ourselves and contributors with the sheer number of existing linter errors, this PR takes a more incremental approach: Only the Fortran files that are changed in a PR are checked and reported. This allows us to gradually improve the CAM-SIMA codebase over time.

As a demonstration, this PR fixes the following linter errors in the cam_logfile module:

• 22:4 MOD051 save statement is superfluous at the module level
• 53:1 S233 Keyword CONTAINS should be contains
• 97:10 C043 File opened without the action specifier
• 100:41 C183 iostat used without iomsg
• 128:35 S241 String uses double quotes but single quotes are preferred
• 134:7 S271 use statements are not sorted
• 169:7 S271 use statements are not sorted
• 170:7 C122 use for intrinsic module missing the intrinsic modifier

The full linter output can be inspected in the CI logs.

Describe any changes made to the build system

None

Describe any changes made to the namelist

None

List any changes to the defaults for the input datasets (e.g., initial, boundary datasets)

None

List all files eliminated and why

None

List all files added and what they do

A       test/fortitude.toml
    * Introduce Fortitude linting to CAM-SIMA Fortran CI

List all existing files that have been modified, and describe the changes

M       .github/workflows/cam_sima_fortran_ci.yml
    * Update GHA versions again
    * Remove unnecessary escapes for forward slashes
    * Introduce Fortitude linting to CAM-SIMA Fortran CI
M       .github/workflows/mpas_dynamical_core_ci.yml
    * Update GHA versions again
    * Pin Fortitude to 0.9.*
    * Should update `pip` itself before any other package operations
    * Update Fortitude configuration
    * Remove unnecessary escapes for forward slashes
    * Save matched paths for use with subsequent CI jobs
M       src/control/cam_logfile.F90
    * Do not use magic number for standard output
    * Fix linter error: MOD051 `save` statement is superfluous at the module level
    * Fix linter error: S233 Keyword `CONTAINS` should be `contains`
    * Fix linter error: C043 File opened without the `action` specifier
    * Fix linter error: C183 `iostat` used without `iomsg`
    * Fix linter error: S241 String uses double quotes but single quotes are preferred
    * Fix linter error: S271 `use` statements are not sorted
    * Fix linter error: C122 `use` for intrinsic module missing the `intrinsic` modifier
M       src/dynamics/mpas/assets/fortitude_config.toml
    * Update Fortitude configuration

Regression tests

• derecho/aux_sima_gnu

Pass.

• derecho/aux_sima_intel

  SMS_Ln9.ne3pg3_ne3pg3_mg37.FKESSLER.derecho_intel.cam-outfrq_se_cslam_multitape (Overall: NLFAIL) details:
    FAIL SMS_Ln9.ne3pg3_ne3pg3_mg37.FKESSLER.derecho_intel.cam-outfrq_se_cslam_multitape NLCOMP

Known failing test.

• derecho/aux_sima_nvhpc

Pass.

[jimmielin]

This is really cool, thanks @kuanchihwang. I just had a couple of potential changes for your consideration but nothing blocking the review.

[jimmielin]

Thanks @kuanchihwang for addressing my comments!

[peverwhee]

one question and a couple requests on the SIMA toml file. thanks @kuanchihwang !

[peverwhee]

thanks @kuanchihwang !

[peverwhee]

@kuanchihwang you can go ahead and merge this whenever you're ready