Y1

.ci-support/install-mirge-from-source.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -x
+#
+# This script is intended to install mirgecom from an uninstalled
+# mirgecom source gotten from a fresh clone.
+#
+EMIRGE_INSTALL_PATH=${1:-"."}
+
+echo "EMIRGE_INSTALL_PATH=${EMIRGE_INSTALL_PATH}"
+
+# Install the version of mirgecom we wish to test from source
+./install.sh --skip-clone --install-prefix=${EMIRGE_INSTALL_PATH}/ --conda-env=${EMIRGE_INSTALL_PATH}/mirgecom/conda-env.yml --pip-pkgs=${EMIRGE_INSTALL_PATH}/mirgecom/requirements.txt
+

.ci-support/merge-install-production-branch.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+set -x
+#
+# This script is designed to patch the CEESD production capability into
+# a proposed change to illinois-ceesd/mirgecom@main. The script reads the
+# environment config file `.ci-support/production-testing-env.sh`, that
+# should set up the expected control variables.
+#
+# The production capability to test against may be specified outright, or
+# patched by the incoming development. The following vars control the
+# production environment:
+#
+# PRODUCTION_BRANCH = The production branch (default=y1-production)
+# PRODUCTION_FORK = The production fork (default=illinois-ceesd)
+#
+MIRGE_HOME=${1:-"."}
+PRODUCTION_BRANCH=${PRODUCTION_BRANCH:-"y1-production"}
+PRODUCTION_FORK=${PRODUCTION_FORK:-"illinois-ceesd"}
+
+echo "MIRGE_HOME=${MIRGE_HOME}"
+echo "PRODUCTION_FORK=$PRODUCTION_FORK"
+echo "PRODUCTION_BRANCH=$PRODUCTION_BRANCH"
+
+cd ${MIRGE_HOME}
+git status
+
+# This junk is needed to be able to execute git commands properly
+git config user.email "ci-runner@ci.machine.com"
+git config user.name "CI Runner"
+
+# Making a dedicated production remote adds production forks
+git remote add production https://github.com/${PRODUCTION_FORK}/mirgecom
+git fetch production
+
+# Merge the production branch for testing the production drivers
+git merge production/${PRODUCTION_BRANCH} --no-edit
+# Pick up any requirements.txt
+pip install -r requirements.txt
+cd -

.ci-support/production-driver-install.sh → .ci-support/production-drivers-install.sh

@@ -12,19 +12,9 @@
 # The default values result in an install of the Y1 nozzle driver and
 # Wyatt Hagen's isolator driver that work with current MIRGE-Com 
 # production branch: mirgecom@y1-production.
-#
+PRODUCTION_DRIVERS=${PRODUCTION_DRIVERS:-"illinois-ceesd/drivers_y1-nozzle@parallel-lazy:illinois-ceesd/drivers_y2-isolator@main:illinois-ceesd/drivers_flame1d@nodal-reduction-device-scalar"}
+# Loop over the production drivers, clone them, and prepare for execution
 set -x
-
-DEVELOPMENT_BRANCH="$GITHUB_HEAD_REF"  # this will be empty for main
-PRODUCTION_DRIVERS=""
-if [ -n "$DEVELOPMENT_BRANCH" ]; then
-    PRODUCTION_ENV_FILE="$1"
-    if [ -e "$PRODUCTION_ENV_FILE" ]; then
-        . $PRODUCTION_ENV_FILE
-    fi
-fi
-# Set to default if testing main, or user left it empty
-PRODUCTION_DRIVERS=${PRODUCTION_DRIVERS:-"illinois-ceesd/drivers_y1-nozzle@main:w-hagen/isolator@master:illinois-ceesd/drivers_flame1d@main"}
 OIFS="$IFS"
 IFS=':'; for production_driver_string in $PRODUCTION_DRIVERS;
 do
@@ -34,7 +24,7 @@ do
     PRODUCTION_DRIVER_DIR="production_driver_$PRODUCTION_DRIVER_NAME"
     git clone -b "$PRODUCTION_DRIVER_BRANCH" https\://github.com/"$PRODUCTION_DRIVER_REPO" "$PRODUCTION_DRIVER_DIR"
     cd "$PRODUCTION_DRIVER_DIR"/smoke_test
-    ln -s *.py driver.py
+    ln -s *.py driver.py  #  name the driver generically
     cd ../..
 done
 IFS="$OIFS"

.ci-support/production-drivers-run.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+set -x
+# This script is designed to run the CEESD "production" drivers after
+# they have been prepared by an external helper script called
+# production-drivers-install.sh. The drivers are each expected to be
+# in a directory called "production_driver_*" and are expected to have
+# a test driver in "production_driver_*/smoke_test/driver.py".
+DRIVERS_HOME=${1:-"."}
+cd ${DRIVERS_HOME}
+for production_driver in $(ls | grep "production_driver_");
+do
+    cd "$production_driver"/smoke_test
+    python -m mpi4py ./driver.py -i run_params.yaml
+    cd ../../
+done
+cd -

.ci-support/production-testing-env.sh

@@ -1,19 +1,12 @@
 #!/bin/bash
 set -x
 #
-# This script is designed to help customize the production environemtn
+# This script is designed to help customize the production environment
 # under which CEESD production capability is tested under a proposed change
-# to illinois-ceesd/mirgecom@main. If necessary, the script sets the
-# following vars:
+# to illinois-ceesd/mirgecom@main.
 #
-# The proposed changes to test may be in a fork, or a local branch. For
-# forks, the environment config files should set:
-#
-# export DEVELOPMENT_FORK=""   # the fork/home of the development
-#
-# The production capability to test against may be specified outright, or
-# patched by the incoming development. The following vars control the
-# production environment:
+# The production capability may be in a CEESD-local mirgecom branch or in a
+# fork, and is specified through the following settings:
 #
 # export PRODUCTION_BRANCH=""   # The base production branch to be installed by emirge
 # export PRODUCTION_FORK=""  # The fork/home of production changes (if any)

.github/workflows/ci.yaml

@@ -79,7 +79,8 @@ jobs:
             MINIFORGE_INSTALL_DIR=.miniforge3
             . "$MINIFORGE_INSTALL_DIR/bin/activate" testing
             cd test
-            python -m pytest --cov=mirgecom --durations=0 --tb=native --junitxml=pytest.xml --doctest-modules -rxsw . ../doc/*.rst ../doc/*/*.rst
+            python -m pip install pytest-xdist
+            python -m pytest -n auto --cov=mirgecom --durations=0 --tb=native --junitxml=pytest.xml --doctest-modules -rxsw . ../doc/*.rst ../doc/*/*.rst
 
     examples:
         name: Examples
@@ -163,22 +164,24 @@ jobs:
 
         steps:
         - uses: actions/checkout@v2
+          with:
+            fetch-depth: '0'
         - name: Prepare production environment
           run: |
             [[ $(uname) == Linux ]] && sudo apt-get update && sudo apt-get install -y openmpi-bin libopenmpi-dev
             [[ $(uname) == Darwin ]] && brew update && brew install mpich
+            MIRGEDIR=$(pwd)
+            cat .ci-support/production-testing-env.sh
+            . .ci-support/production-testing-env.sh
             cd ..
             git clone https://github.com/illinois-ceesd/emirge emirge.y1
             cd emirge.y1
-            . ../mirgecom/.ci-support/production-install.sh ../mirgecom/.ci-support/production-testing-env.sh
+            . ../mirgecom/.ci-support/install-mirge-from-source.sh ${MIRGEDIR}/..
+            source ${MIRGEDIR}/../config/activate_env.sh
+            . ../mirgecom/.ci-support/merge-install-production-branch.sh ${MIRGEDIR}
         - name: Run production test
           run: |
-            cd ..
-            source emirge.y1/config/activate_env.sh
-            . mirgecom/.ci-support/production-driver-install.sh mirgecom/.ci-support/production-testing-env.sh
-            for production_driver in $(ls | grep "production_driver_");
-            do
-               cd "$production_driver"/smoke_test
-               python -m mpi4py ./driver.py -i run_params.yaml
-               cd ../../
-            done
+            . .ci-support/production-testing-env.sh
+            source ../config/activate_env.sh
+            . .ci-support/production-drivers-install.sh .
+            . .ci-support/production-drivers-run.sh .

doc/development/pullrequests.rst

@@ -206,6 +206,92 @@ commit, you can use a git hook such as the following one (save this script as
 
 While highly recommended, hooks can sometimes be annoying. After setting up your hooks, you can use ``git --no-verify`` or equivalently ``git -n`` to run ``git`` commands without triggering the hooks.
 
+Production Testing in CI
+------------------------
+
+The CI testing in mirgecom includes a set of "production" tests which help
+detect when a proposed change in a PR breaks the CEESD prediction capability
+toolchain.  Most developments and PRs do not require special considerations
+for the production tests, but any production test failures will require
+a bit of care to resolve.
+
+When PRs run afoul of the CI production tests, it indicates that if the PR
+change set merges to main, then the "production" capability of mirgecom will
+not function until the production capability and the change set are brought
+into accordance.
+
+To resolve CI production test failures for a development in PR, it is often useful
+to run the production tests manually. The production tests may be prepared and
+executed from anywhere by hand-executing the production test scripts found in
+``.ci-support/``. The following is an example workflow adjacent to what CI itself
+does for executing the production tests.
+
+1. Check out the PR development (and optionally make a production branch)
+
+   The PR development is assumed to be in a mirgecom branch called ``branch-name``
+   and possibly in a fork called ``fork-name``.
+
+   .. code:: bash
+
+      $ # For ceesd-local branches:
+      $ git clone -b branch-name git@github.com:/illinois-ceesd/mirgecom
+      $ # Or for developer fork:
+      $ git clone -b branch-name git@github.com:/fork-name/mirgecom
+      $ cd mirgecom           # or loopy, meshmode, ...
+      $ git switch -c branch-name-production  # Optional production branch
+
+2. Set up the production environment and capability
+
+   .. code:: bash
+
+      $ # Load the customizable production environment
+      $ . .ci-support/production-testing-env.sh
+      $ # Merge the production branch
+      $ . .ci-support/merge-install-production-branch.sh .
+
+   If Step 2 fails, i.e. if there are merge conflicts, then those must
+   be resolved. Push the merged result to CEESD or a fork, and indicate
+   that version in the PRODUCTION_FORK, and PRODUCTION_BRANCH env vars in
+   ``.ci-support/production-testing-env.sh``.
+
+3. Grab and run the production tests
+
+   .. code:: bash
+
+      $ # Load env if needed
+      $ . .ci-support/production-testing-env.sh
+      $ # Get the production tests
+      $ . .ci-support/production-drivers-install.sh .
+      $ # Run the production tests
+      $ . .ci-support/production-drivers-run.sh .
+
+   Step 3 will clone the production driver repos to the current directory,
+   with each driver in its own directory. If any of the drivers fail to
+   work with the current development, then they may be modified into working
+   condition and then pushed to a repo/branch. Indicate the location of the working
+   drivers in the PRODUCTION_DRIVERS env var customization in
+   ``.ci-support/production-testing-env.sh``.
+
+4. Update the PR to reflect the change in production environment (if any)
+
+   Push the customized production ``.ci-support/production-testing-env.sh``
+   settings to the PR development branch. Upon push, mirgecom CI will
+   try the production tests again, now with the customized environment.
+
+
+If the PR development requires production environment customization in order to
+pass production tests, then care and coordination will be required to get these
+changes merged into the main mirgecom development.  PR reviewers will help
+with this process.  If the PR is accepted for merging to main, then mirgecom
+developers will update the production capabilities to be compatible with
+the changes before merging.
+
+ .. important::
+
+    Any production environment customizations must be backed out before
+    merging the PR development to main. Never merge a PR development with
+    production environment customizations in-place.
+
 Merging a pull request
 ----------------------