Implement GitHub Actions CI testing (Fixes #138)

.github/workflows/general-ci-tests.yml

@@ -0,0 +1,110 @@
+name: General MOM_interface CI
+
+# This CI workflow tests against the following questions: 
+# 1. Does standalone mom build and run?
+# 2. Does it pass the tests/check_default_params.py test?
+# 3. Do the scripts in cime_config pass the black formatter? 
+# Please see Issue #138 for more information
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the listed branches
+  push:
+    branches: ["main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  check_standalone_mom_build_and_run_lightweight_examples:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    steps:
+
+    # Copied from NCAR/MOM6 - Install Basic Build Packages for MOM6
+      - name: Install Ubuntu Linux packages
+        shell: bash
+        run: |
+          echo "::group::Install linux packages"
+          sudo apt-get update
+          sudo apt-get install netcdf-bin
+          sudo apt-get install libnetcdf-dev
+          sudo apt-get install libnetcdff-dev
+          sudo apt-get install openmpi-bin
+          sudo apt-get install libopenmpi-dev
+          sudo apt-get install linux-tools-common
+          sudo apt-get install -y csh
+          echo "::endgroup::"
+
+      # Checkout CESM (cesm3_0_alpha03a) and externals
+      - name: Checkout CESM and Externals
+        run: |
+          git clone https://github.com/ESCOMP/CESM.git -b cesm3_0_alpha03a cesm3_0_alpha03a
+          cd cesm3_0_alpha03a
+          ./bin/git-fleximod update
+
+      # Checkout the correct MOM Branch
+      - name: Checkout initial event (Pull Request)
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          echo "Handling pull request"
+          cd $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/
+          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr-${{ github.event.pull_request.number }}
+          git checkout pr-${{ github.event.pull_request.number }}
+
+      - name: Checkout initial event (Push)
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          echo "Handling push"
+          cd $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/
+          git checkout ${{ github.sha }}
+
+      # Build the standalone mom using the macos script. build_examples-ncar doesn't work.    
+      - name: Build Standalone MOM
+        run: |
+          cd $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/standalone/build
+          ./build_examples-darwin.sh
+
+      # CD into a couple MOM examples and run MOM in them. These are very light weight and quick.
+      - name: Run Double Gyre Test
+        run: |
+          cd $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/standalone/examples/double_gyre
+          $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/standalone/build/gnu/MOM6/MOM6
+      - name: Run Single Column KPP Test
+        run: |
+          cd $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/standalone/examples/single_column/KPP
+          $GITHUB_WORKSPACE/cesm3_0_alpha03a/components/mom/standalone/build/gnu/MOM6/MOM6
+
+
+  # Job to run the check_default_params script, which is a test
+  check_default_params:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repo
+      - uses: actions/checkout@v4
+
+      # Run the test
+      - name: Run the check_default_params script
+        run: python tests/check_default_params.py
+
+  # Job to run the black formatter for cime_config, see black documentation for more info
+  check_black_format_for_cime_config:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repo
+      - uses: actions/checkout@v4
+
+      # Run black check
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose"
+          src: "./cime_config"
+
+
+
+

cime_config/SystemTests/dimcs.py

@@ -32,8 +32,8 @@
     "H_RESCALE_POWER = -11",
     "Z_RESCALE_POWER = -11",
     "R_RESCALE_POWER = -11",
-    "Q_RESCALE_POWER = -11"
-    ]
+    "Q_RESCALE_POWER = -11",
+]
 
 run_suffixes = [
     "base",
@@ -67,27 +67,36 @@
     "scale the dimension Q by 2**-11",
 ]
 
+
 class DIMCS(SystemTestsCompareN):
 
     def __init__(self, case):
         self.comp = case.get_value("COMP_OCN")
-        SystemTestsCompareN.__init__(self, case, N=len(nl_contents),
-                                     separate_builds = False,
-                                     run_suffixes = run_suffixes,
-                                     run_descriptions = run_descriptions,
-                                     ignore_fieldlist_diffs = True)
+        SystemTestsCompareN.__init__(
+            self,
+            case,
+            N=len(nl_contents),
+            separate_builds=False,
+            run_suffixes=run_suffixes,
+            run_descriptions=run_descriptions,
+            ignore_fieldlist_diffs=True,
+        )
 
     def _common_setup(self):
-        nl_contents_common = '''
+        nl_contents_common = """
             ! DIMCS test changes
-        '''
-        append_to_user_nl_files(caseroot = self._case.get_value("CASEROOT"),
-                                component = self.comp,
-                                contents = nl_contents_common)
+        """
+        append_to_user_nl_files(
+            caseroot=self._case.get_value("CASEROOT"),
+            component=self.comp,
+            contents=nl_contents_common,
+        )
 
     def _case_setup(self, i):
 
         # Second append user_nl change sepecific to case-i
-        append_to_user_nl_files(caseroot = self._case.get_value("CASEROOT"),
-                                component = self.comp,
-                                contents = nl_contents[i])
+        append_to_user_nl_files(
+            caseroot=self._case.get_value("CASEROOT"),
+            component=self.comp,
+            contents=nl_contents[i],
+        )

cime_config/SystemTests/dimcsl.py

@@ -27,7 +27,7 @@
     "Z_RESCALE_POWER = 11",
     "R_RESCALE_POWER = 11",
     "Q_RESCALE_POWER = 11",
-    ]
+]
 
 run_suffixes = [
     "base",
@@ -49,27 +49,36 @@
     "scale the dimension Q by 2**11",
 ]
 
+
 class DIMCSL(SystemTestsCompareN):
 
     def __init__(self, case):
         self.comp = case.get_value("COMP_OCN")
-        SystemTestsCompareN.__init__(self, case, N=len(nl_contents),
-                                     separate_builds = False,
-                                     run_suffixes = run_suffixes,
-                                     run_descriptions = run_descriptions,
-                                     ignore_fieldlist_diffs = True)
+        SystemTestsCompareN.__init__(
+            self,
+            case,
+            N=len(nl_contents),
+            separate_builds=False,
+            run_suffixes=run_suffixes,
+            run_descriptions=run_descriptions,
+            ignore_fieldlist_diffs=True,
+        )
 
     def _common_setup(self):
-        nl_contents_common = '''
+        nl_contents_common = """
             ! DIMCSL test changes
-        '''
-        append_to_user_nl_files(caseroot = self._case.get_value("CASEROOT"),
-                                component = self.comp,
-                                contents = nl_contents_common)
+        """
+        append_to_user_nl_files(
+            caseroot=self._case.get_value("CASEROOT"),
+            component=self.comp,
+            contents=nl_contents_common,
+        )
 
     def _case_setup(self, i):
 
         # Second append user_nl change sepecific to case-i
-        append_to_user_nl_files(caseroot = self._case.get_value("CASEROOT"),
-                                component = self.comp,
-                                contents = nl_contents[i])
+        append_to_user_nl_files(
+            caseroot=self._case.get_value("CASEROOT"),
+            component=self.comp,
+            contents=nl_contents[i],
+        )