Merge pull request #2743 from IntersectMBO/imp_ci_grouping

feat: add group for script setup in CI scripts

Author: mkoura

.github/node_upgrade.sh

@@ -55,6 +55,14 @@ mkdir -p "$COVERAGE_DIR"
 export SCHEDULING_LOG=scheduling.log
 true > "$SCHEDULING_LOG"
 
+export DEV_CLUSTER_RUNNING=1 CLUSTERS_COUNT=1 FORBID_RESTART=1 TEST_THREADS=10 NUM_POOLS="${NUM_POOLS:-4}"
+unset ENABLE_LEGACY MIXED_P2P
+
+echo "::endgroup::"  # end group for "Script setup"
+
+echo "::group::Nix env setup"
+printf "start: %(%H:%M:%S)T\n" -1
+
 # shellcheck disable=SC1090,SC1091
 . .github/nix_override_cardano_node.sh
 
@@ -70,12 +78,6 @@ else
   NODE_OVERRIDE=$(node_override)
 fi
 
-export DEV_CLUSTER_RUNNING=1 CLUSTERS_COUNT=1 FORBID_RESTART=1 TEST_THREADS=10 NUM_POOLS="${NUM_POOLS:-4}"
-unset ENABLE_LEGACY MIXED_P2P
-
-echo "::group::Nix env setup"
-printf "start: %(%H:%M:%S)T\n" -1
-
 set +e
 # shellcheck disable=SC2086
 nix flake update --accept-flake-config $NODE_OVERRIDE
@@ -89,7 +91,7 @@ nix develop --accept-flake-config .#venv --command bash -c '
   . .github/setup_venv.sh clean
   echo "::endgroup::"  # end group for "Python venv setup"
 
-  echo "::group::Pytest step1"
+  echo "::group::-> PYTEST STEP1 <-"
   df -h .
   # prepare scripts for stating cluster instance, start cluster instance, run smoke tests
   ./.github/node_upgrade_pytest.sh step1
@@ -104,8 +106,8 @@ fi
 # retval 0 == all tests passed; 1 == some tests failed; > 1 == some runtime error and we don't want to continue
 [ "$retval" -le 1 ] || exit "$retval"
 
-echo "::endgroup::"  # end group for "Pytest step1"
-echo "::group::Pytest step2"
+echo "::endgroup::"  # end group for "-> PYTEST STEP1 <-"
+echo "::group::-> PYTEST STEP2 <-"
 
 # update cardano-node to specified branch and/or revision, or to the latest available revision
 if [ -n "${UPGRADE_REVISION:-""}" ]; then
@@ -130,14 +132,14 @@ nix develop --accept-flake-config .#venv --command bash -c '
   retval="$?"
   # retval 0 == all tests passed; 1 == some tests failed; > 1 == some runtime error and we dont want to continue
   [ "$retval" -le 1 ] || exit "$retval"
-  echo "::endgroup::"  # end group for "Pytest step2"
+  echo "::endgroup::"  # end group for "-> PYTEST STEP2 <-"
 
-  echo "::group::Pytest step3"
+  echo "::group::-> PYTEST STEP3 <-"
   df -h .
   # update to Conway, run smoke tests
   ./.github/node_upgrade_pytest.sh step3
   retval="$?"
-  echo "::endgroup::"  # end group for "Pytest step3"
+  echo "::endgroup::"  # end group for "-> PYTEST STEP3 <-"
 
   echo "::group::Cluster teardown & artifacts"
   # teardown cluster

.github/regression.sh

@@ -26,48 +26,6 @@ mkdir -p "$WORKDIR"
 export TMPDIR="$WORKDIR/tmp"
 mkdir -p "$TMPDIR"
 
-# setup dbsync (disabled by default)
-case "${DBSYNC_REV:-""}" in
-  "" )
-    ;;
-  "none" )
-    unset DBSYNC_REV
-    ;;
-  * )
-    # shellcheck disable=SC1090,SC1091
-    . .github/source_dbsync.sh
-    df -h .
-    ;;
-esac
-
-# Setup plutus-apps (disabled by default).
-# The "plutus-apps" repo is needed for the `create-script-context` tool, which is used by the
-# Plutus tests that are testing script context.
-# TODO: The `create-script-context` tool is broken for a very long time, hence disabled.
-# See https://github.com/IntersectMBO/plutus-apps/issues/1107
-case "${PLUTUS_APPS_REV:="none"}" in
-  "none" )
-    unset PLUTUS_APPS_REV
-    ;;
-  * )
-    # shellcheck disable=SC1090,SC1091
-    . .github/source_plutus_apps.sh
-    ;;
-esac
-
-# setup cardano-cli (use the built-in version by default)
-case "${CARDANO_CLI_REV:-""}" in
-  "" )
-    ;;
-  "none" )
-    unset CARDANO_CLI_REV
-    ;;
-  * )
-    # shellcheck disable=SC1090,SC1091
-    . .github/source_cardano_cli.sh
-    ;;
-esac
-
 if [ "${CI_TOPOLOGY:-""}" = "legacy" ]; then
   export ENABLE_LEGACY=1
 elif [ "${CI_TOPOLOGY:-""}" = "mixed" ]; then
@@ -127,9 +85,49 @@ if [ -n "${BOOTSTRAP_DIR:-""}" ]; then
   export MAKE_TARGET="${MAKE_TARGET:-"testnets"}"
 fi
 
-# function to update cardano-node to specified branch and/or revision, or to the latest available
-# shellcheck disable=SC1090,SC1091
-. .github/nix_override_cardano_node.sh
+echo "::endgroup::"  # end group for "Script setup"
+
+# setup dbsync (disabled by default)
+case "${DBSYNC_REV:-""}" in
+  "" )
+    ;;
+  "none" )
+    unset DBSYNC_REV
+    ;;
+  * )
+    # shellcheck disable=SC1090,SC1091
+    . .github/source_dbsync.sh
+    df -h .
+    ;;
+esac
+
+# Setup plutus-apps (disabled by default).
+# The "plutus-apps" repo is needed for the `create-script-context` tool, which is used by the
+# Plutus tests that are testing script context.
+# TODO: The `create-script-context` tool is broken for a very long time, hence disabled.
+# See https://github.com/IntersectMBO/plutus-apps/issues/1107
+case "${PLUTUS_APPS_REV:="none"}" in
+  "none" )
+    unset PLUTUS_APPS_REV
+    ;;
+  * )
+    # shellcheck disable=SC1090,SC1091
+    . .github/source_plutus_apps.sh
+    ;;
+esac
+
+# setup cardano-cli (use the built-in version by default)
+case "${CARDANO_CLI_REV:-""}" in
+  "" )
+    ;;
+  "none" )
+    unset CARDANO_CLI_REV
+    ;;
+  * )
+    # shellcheck disable=SC1090,SC1091
+    . .github/source_cardano_cli.sh
+    ;;
+esac
 
 _cleanup() {
   # stop all running cluster instances
@@ -176,6 +174,10 @@ trap 'set +e; _interrupted; exit 130' SIGINT
 echo "::group::Nix env setup"
 printf "start: %(%H:%M:%S)T\n" -1
 
+# function to update cardano-node to specified branch and/or revision, or to the latest available
+# shellcheck disable=SC1090,SC1091
+. .github/nix_override_cardano_node.sh
+
 # run tests and generate report
 set +e
 # shellcheck disable=SC2046,SC2119
@@ -190,7 +192,7 @@ nix develop --accept-flake-config .#venv --command bash -c '
   . .github/setup_venv.sh clean
   echo "::endgroup::"  # end group for "Python venv setup"
 
-  echo "::group::Pytest run"
+  echo "::group::-> PYTEST RUN <-"
   export PATH="${PWD}/.bin":"$WORKDIR/cardano-cli/cardano-cli-build/bin":"$PATH"
   export CARDANO_NODE_SOCKET_PATH="$CARDANO_NODE_SOCKET_PATH_CI"
   make "${MAKE_TARGET:-"tests"}"

.github/workflows/regression_reusable.yaml

@@ -108,7 +108,10 @@ jobs:
           fi
       - name: Run CLI regression tests
         id: testing-step
-        run: .github/regression.sh
+        run: |
+          # Regression Tests
+          echo "::group::Script setup"
+          .github/regression.sh
       - name: Report test results
         if: (success() || failure()) && inputs.testrun_name
         run: |

.github/workflows/upgrade_reusable.yaml

@@ -43,9 +43,12 @@ jobs:
           cat .github_ci_env
           cat .github_ci_env >> $GITHUB_ENV
           echo "GITHUB_TOKEN=${{ secrets.GH_TOKEN }}" >> $GITHUB_ENV
-      - name: Run CLI regression tests
+      - name: Run upgrade tests
         id: testing-step
-        run: ./.github/node_upgrade.sh
+        run: |
+          # Upgrade Tests
+          echo "::group::Script setup"
+          ./.github/node_upgrade.sh
       - name: Upload testing artifacts on failure
         uses: actions/upload-artifact@v4
         if: failure()