Edits to coverage reporting structure and created directory

.github/workflows/github-actions.yml

@@ -21,9 +21,9 @@ jobs:
       # Reducing the frequency of coverage checks may be preferable if this increases.
       # report_py_coverage is being called twice, once within check_py_coverage to print to the terminal and once here to get data for the annotation
       - run: >
-          ./check_py_coverage.sh -j4 &&
-          DATA_FILE=`pwd`/.coverage && COV_RCFILE=`pwd`/tests/.coveragerc &&
-          COV_RPT=`bash report_py_coverage.sh --data-file=$DATA_FILE --coverage-rc-file=$COV_RCFILE` &&
+          ./coverage_scripts/check_py_coverage.sh -j4 &&
+          DATA_FILE=`pwd`/.coverage && COV_RCFILE=`pwd`/coverage_scripts/.coveragerc &&
+          COV_RPT=`bash coverage_scripts/report_py_coverage.sh --data-file=$DATA_FILE --coverage-rc-file=$COV_RCFILE` &&
           echo "::notice title=Coverage Summary::$COV_RPT For details, download 'coverage_results' from Artifacts, extract all files, and open 'index.html'."
       - name: Archive coverage results
         uses: actions/upload-artifact@v4

coverage_scripts/check_py_coverage.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+SCRIPT_DIRNAME=`dirname $0`
+HERON_DIR=`(cd $SCRIPT_DIRNAME/..; pwd)`
+cd $HERON_DIR
+RAVEN_DIR=`python -c 'from src._utils import get_raven_loc; print(get_raven_loc())'`
+
+bash $HERON_DIR/coverage_scripts/initialize_coverage.sh
+
+#coverage help run
+SRC_DIR=`(cd src && pwd)`
+
+# get display var
+DISPLAY_VAR=`(echo $DISPLAY)`
+# reset it
+export DISPLAY=
+
+export COVERAGE_RCFILE="$SRC_DIR/../coverage_scripts/.coveragerc"
+SOURCE_DIRS=($SRC_DIR,$SRC_DIR/../templates/)
+OMIT_FILES=($SRC_DIR/dispatch/twin_pyomo_test.py,$SRC_DIR/dispatch/twin_pyomo_test_rte.py,$SRC_DIR/dispatch/twin_pyomo_limited_ramp.py,$SRC_DIR/ArmaBypass.py)
+EXTRA="--source=${SOURCE_DIRS[@]} --omit=${OMIT_FILES[@]} --parallel-mode "
+export COVERAGE_FILE=`pwd`/.coverage
+
+coverage erase
+($RAVEN_DIR/run_tests "$@" --re=HERON/tests --python-command="coverage run $EXTRA " || echo run_tests done but some tests failed)
+
+#get DISPLAY BACK
+DISPLAY=$DISPLAY_VAR
+
+## Prepare data and generate the html documents
+coverage combine
+coverage html
+
+# See report_py_coverage.sh file for explanation of script separation
+(bash $HERON_DIR/coverage_scripts/report_py_coverage.sh --data-file=$COVERAGE_FILE --coverage-rc-file=$COVERAGE_RCFILE)

check_py_coverage.sh → coverage_scripts/initialize_coverage.sh

@@ -1,13 +1,17 @@
 #!/bin/bash
+
+# This script prepares for running commands from the coverage package
+
 SCRIPT_DIRNAME=`dirname $0`
-SCRIPT_DIR=`(cd $SCRIPT_DIRNAME; pwd)`
+HERON_DIR=`(cd $SCRIPT_DIRNAME/..; pwd)`
+echo $HERON_DIR
+cd $HERON_DIR
 RAVEN_DIR=`python -c 'from src._utils import get_raven_loc; print(get_raven_loc())'`
 source $RAVEN_DIR/scripts/establish_conda_env.sh --quiet --load
 RAVEN_LIBS_PATH=`conda env list | awk -v rln="$RAVEN_LIBS_NAME" '$0 ~ rln {print $NF}'`
 BUILD_DIR=${BUILD_DIR:=$RAVEN_LIBS_PATH/build}
 INSTALL_DIR=${INSTALL_DIR:=$RAVEN_LIBS_PATH}
 PYTHON_CMD=${PYTHON_CMD:=python}
-JOBS=${JOBS:=1}
 mkdir -p $BUILD_DIR
 mkdir -p $INSTALL_DIR
 DOWNLOADER='curl -C - -L -O '
@@ -45,32 +49,3 @@ else
 fi
 
 update_python_path
-
-cd $SCRIPT_DIR
-
-#coverage help run
-SRC_DIR=`(cd src && pwd)`
-
-# get display var
-DISPLAY_VAR=`(echo $DISPLAY)`
-# reset it
-export DISPLAY=
-
-export COVERAGE_RCFILE="$SRC_DIR/../tests/.coveragerc"
-SOURCE_DIRS=($SRC_DIR,$SRC_DIR/../templates/)
-OMIT_FILES=($SRC_DIR/dispatch/twin_pyomo_test.py,$SRC_DIR/dispatch/twin_pyomo_test_rte.py,$SRC_DIR/dispatch/twin_pyomo_limited_ramp.py,$SRC_DIR/ArmaBypass.py)
-EXTRA="--source=${SOURCE_DIRS[@]} --omit=${OMIT_FILES[@]} --parallel-mode "
-export COVERAGE_FILE=`pwd`/.coverage
-
-coverage erase
-($RAVEN_DIR/run_tests "$@" --re=HERON/tests --python-command="coverage run $EXTRA " || echo run_tests done but some tests failed)
-
-#get DISPLAY BACK
-DISPLAY=$DISPLAY_VAR
-
-## Prepare data and generate the html documents
-coverage combine
-coverage html
-
-# See report_py_coverage.sh file for explanation of script separation
-(bash $SCRIPT_DIR/report_py_coverage.sh --data-file=$COVERAGE_FILE --coverage-rc-file=$COVERAGE_RCFILE)

report_py_coverage.sh → coverage_scripts/report_py_coverage.sh

@@ -7,13 +7,10 @@
 #   "coverage report --format=total" directly in the yaml does not work
 
 SCRIPT_DIRNAME=`dirname $0`
-cd $SCRIPT_DIRNAME
+HERON_DIR=`(cd $SCRIPT_DIRNAME/..; pwd)`
+cd $HERON_DIR
 
-if ! which coverage > /dev/null 2>&1
-then
-  echo "Could not find coverage module"
-  exit 1
-fi
+bash coverage_scripts/initialize_coverage.sh
 
 # read command-line arguments
 ARGS=()