Linter CI part 1

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Default owners of the repository
+* @metoffice/ssdteam
+
+# Add component owners as appropriate

.github/linters/.perlcriticrc

@@ -0,0 +1,5 @@
+# Report slightly less severe violations (severity >= 4)
+severity = 4
+# Verbosity format
+# filename:line:column [severity policy] message near 'string of source code that caused the violation'
+verbose  = %f:%l:%c [%s %p] %m near '%r'\n

.github/linters/.python-lint

@@ -0,0 +1,20 @@
+[MASTER]
+# Use multiple processes to speed up Pylint.
+jobs=2
+
+[MESSAGES CONTROL]
+# C0114: Missing module docstring (missing-module-docstring)
+# C0116: Missing function or method docstring (missing-function-docstring)
+# C0103: Constant name doesn't conform to UPPER_CASE naming style (invalid-name)
+# C0209: Formatting a regular string which could be an f-string (consider-using-f-string)
+# E0401: Unable to import module (import-error)
+# W0611: Unused import sphinx_rtd_theme (unused-import)
+# W0622: Redefining built-in 'copyright' (redefined-builtin)
+# R0801: Similar lines in 2 files
+disable=C0114,C0116,C0103,C0209,E0401,W0611,W0622,R0801,
+
+[SIMILARITIES]
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+ignore-comments=yes
+ignore-docstrings=yes

.github/linters/.ruff.toml

@@ -0,0 +1,20 @@
+cache-dir = "/tmp/.ruff_cache"
+line-length = 80
+
+[lint]
+# C0116: Missing function or method docstring (missing-function-docstring)
+# C0103: Constant name doesn't conform to UPPER_CASE naming style (invalid-name)
+# C0209: Formatting a regular string which could be an f-string (consider-using-f-string)
+# W0622: Redefining built-in 'copyright' (redefined-builtin)
+# R0801: Similar lines in 2 files
+ignore = ["C0116","C0103","C0209","W0622","R0801",]
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[format]
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false

.github/linters/.shellcheckrc

@@ -0,0 +1 @@
+source-path=SCRIPTDIR

.github/pull_request_template.md

@@ -0,0 +1,32 @@
+# Description
+
+## Summary
+
+_Briefly describe the feature being introduced._
+
+## Changes
+
+_List the major changes made in this pull request._
+
+## Dependency
+
+_List dependent changes. Can use build-group logic here._
+
+## Impact
+
+_Discuss any potential impacts this feature may have on existing functionalities._
+
+## Issues addressed
+
+Resolves
+
+_List issue(s) related to this PR._
+
+## Coordinated merge
+
+_Specify any coordinated merges here._
+
+
+## Checklist
+
+- [ ] I have performed a self-review of my own changes

.github/workflows/lint.yml

@@ -0,0 +1,57 @@
+---
+# Lint/analyse code with Super-Linter.
+name: Checks
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main, 'releases/**']
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress:  ${{ github.ref != 'refs/heads/main' }}
+
+permissions: read-all
+
+jobs:
+  check:
+    name: Lint
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    permissions:
+        contents: read
+        packages: read
+        statuses: write
+
+    steps:
+      - name: Checkout current
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Super-Linter
+        uses: super-linter/super-linter/slim@v7.2.1
+        env:
+          FILTER_REGEX_EXCLUDE: (.*[.]conf.py|pull_request_template.md|/linters/)
+          IGNORE_GITIGNORED_FILES: true
+          VALIDATE_BASH_EXEC: false
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          VALIDATE_JSCPD: false
+          VALIDATE_MARKDOWN_PRETTIER: false
+          VALIDATE_PYTHON_FLAKE8: false
+          VALIDATE_PYTHON_ISORT: false
+          VALIDATE_PYTHON_MYPY: false
+          VALIDATE_PYTHON_PYINK: false
+          VALIDATE_PYTHON_PYLINT: false
+          VALIDATE_SHELL_SHFMT: false
+          VALIDATE_YAML_PRETTIER: false
+          VALIDATE_YAML: false
+          # To report GitHub Actions status checks
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+...

.gitignore

@@ -1,2 +1,6 @@
+*.sublime-workspace
+*.code-workspace
+.vscode
 __pycache__/
-
+*.pyc
+*~

README.md

@@ -1,7 +1,11 @@
-# SimSys Scripts
+# Simulation Systems Scripts
 
-This repository contains support scripts that are common across the many simulation and modelling codes owned by the Met Office.
-Particularily those owned and maintained by the SSD team.
+[![Checks](https://github.com/MetOffice/SimSys_Scripts/actions/workflows/lint.yml/badge.svg)](https://github.com/MetOffice/SimSys_Scripts/actions/workflows/lint.yml)
+[![CodeQL](https://github.com/MetOffice/SimSys_Scripts/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/MetOffice/SimSys_Scripts/actions/workflows/github-code-scanning/codeql)
 
-Also contains a copy of script_updater.sh which is intended to live in the fcm repositories to pull from
-this repo.
+This repository contains support scripts that are common across the many
+simulation and modelling codes owned by the Met Office. Particularly those
+owned and maintained by the Simulation Systems and Deployment (SSD) team.
+
+Also contains a copy of `script_updater.sh` which is intended to live in the
+fcm repositories to pull from this repository.

script_umdp3_checker/bin/umdp3_check.pl

@@ -1010,13 +1010,13 @@ sub run_checks {
             }
 
             # read in data from file to $data, then
-            my $io_array = new IO::ScalarArray \@file_lines;
+            my $io_array = IO::ScalarArray->new(\@file_lines);
             my $mimetype = mimetype($io_array);
 
             # if we can't detect a mime type, try some tricks to aid detection
             if ( $mimetype =~ /text\/plain/sxm ) {
                 my @mime_file_lines = grep !/^\s*\#/sxm, @file_lines;
-                $io_array = new IO::ScalarArray \@mime_file_lines;
+                $io_array = IO::ScalarArray->new(\@mime_file_lines);
                 $mimetype = mimetype($io_array);
             }
 
@@ -1133,12 +1133,12 @@ sub run_checks {
                     $filename .= ".";
                 }
                 $filename = $log_cylc . "." . $filename . "report";
-                my $fileres = open( FH, '>', $filename );
+                my $fileres = open( my $fh, '>', $filename );
                 if ( !defined $fileres ) {
                     die "ERR: $filename\n";
                 }
-                print FH $failure_text;
-                close(FH);
+                print $fh $failure_text;
+                close($fh);
             }
         }
         $message = '';