Move some stances around in the ci scripts

Author: mdellweg

templates/github/.github/workflows/scripts/before_install.sh.j2

@@ -2,53 +2,32 @@
 
 {% include 'header.j2' %}
 
-# make sure this script runs at the repo root
-cd "$(dirname "$(realpath -e "$0")")"/../../..
-
 set -mveuo pipefail
 
-if [ "${GITHUB_REF##refs/heads/}" = "${GITHUB_REF}" ]
-then
-  BRANCH_BUILD=0
-else
-  BRANCH_BUILD=1
-  BRANCH="${GITHUB_REF##refs/heads/}"
-fi
-if [ "${GITHUB_REF##refs/tags/}" = "${GITHUB_REF}" ]
-then
-  TAG_BUILD=0
-else
-  TAG_BUILD=1
-  BRANCH="${GITHUB_REF##refs/tags/}"
-fi
+# make sure this script runs at the repo root
+cd "$(dirname "$(realpath -e "$0")")"/../../..
 
-COMMIT_MSG=$(git log --format=%B --no-merges -1)
-export COMMIT_MSG
+export PRE_BEFORE_INSTALL=$PWD/.github/workflows/scripts/pre_before_install.sh
+export POST_BEFORE_INSTALL=$PWD/.github/workflows/scripts/post_before_install.sh
 
 {% if setup_py -%}
 COMPONENT_VERSION=$(sed -ne "s/\s*version.*=.*['\"]\(.*\)['\"][\s,]*/\1/p" setup.py)
 {%- else -%}
 COMPONENT_VERSION=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")
 {%- endif %}
 
+# Compose ansible container definition.
 mkdir .ci/ansible/vars || true
 echo "---" > .ci/ansible/vars/main.yaml
 echo "legacy_component_name: {{ plugin_name | snake }}" >> .ci/ansible/vars/main.yaml
 echo "component_name: {{ plugin_app_label }}" >> .ci/ansible/vars/main.yaml
 echo "component_version: '${COMPONENT_VERSION}'" >> .ci/ansible/vars/main.yaml
 
-export PRE_BEFORE_INSTALL=$PWD/.github/workflows/scripts/pre_before_install.sh
-export POST_BEFORE_INSTALL=$PWD/.github/workflows/scripts/post_before_install.sh
-
 if [ -f $PRE_BEFORE_INSTALL ]; then
   source $PRE_BEFORE_INSTALL
 fi
 
-if [ "$GITHUB_EVENT_NAME" = "pull_request" ] || [ "${BRANCH_BUILD}" = "1" -a "${BRANCH}" != "{{ plugin_default_branch }}" ]
-then
-  echo $COMMIT_MSG | sed -n -e 's/.*CI Base Image:\s*\([-_/[:alnum:]]*:[-_[:alnum:]]*\).*/ci_base: "\1"/p' >> .ci/ansible/vars/main.yaml
-fi
-
+if [[ "$TEST" = "s3" ]]; then
 for i in {1..3}
 do
   ansible-galaxy collection install "amazon.aws:8.1.0" && s=0 && break || s=$? && sleep 3
@@ -58,6 +37,7 @@ then
   echo "Failed to install amazon.aws"
   exit $s
 fi
+fi
 
 if [[ "$TEST" = "pulp" ]]; then
   python3 .ci/scripts/calc_constraints.py -u {% if setup_py -%} requirements.txt {% else -%} pyproject.toml {% endif -%} > upperbounds_constraints.txt

templates/github/.github/workflows/scripts/before_script.sh.j2

@@ -2,6 +2,8 @@
 
 {% include 'header.j2' %}
 
+# This script dumps some files to help understand the setup of the test scenario.
+
 # make sure this script runs at the repo root
 cd "$(dirname "$(realpath -e "$0")")"/../../..
 
@@ -17,33 +19,35 @@ if [[ -f $PRE_BEFORE_SCRIPT ]]; then
 fi
 
 # Developers should be able to reproduce the containers with this config
-echo "CI vars:"
+echo "# CI vars:"
 tail -v -n +1 .ci/ansible/vars/main.yaml
 
 # Developers often want to know the final pulp config
-echo "PULP CONFIG:"
+echo
+echo "# Pulp config:"
 tail -v -n +1 .ci/ansible/settings/settings.* ~/.config/pulp_smash/settings.json
 
-echo "Containerfile:"
+echo
+echo "# Containerfile:"
 tail -v -n +1 .ci/ansible/Containerfile
 
-echo "Constraints Files:"
-# The need not even exist.
+echo
+echo "# Constraints Files:"
+# They need not even exist.
 tail -v -n +1  ../*/*constraints.txt || true
 
-# Needed for some functional tests
-cmd_prefix bash -c "echo '%wheel        ALL=(ALL)       NOPASSWD: ALL' > /etc/sudoers.d/nopasswd"
-cmd_prefix bash -c "usermod -a -G wheel pulp"
+echo
+echo "# pip list outside the container"
 
-if [[ "${REDIS_DISABLED:-false}" == true ]]; then
-  cmd_prefix bash -c "s6-rc -d change redis"
-  echo "The Redis service was disabled for $TEST"
-fi
+echo
+echo "# pip list inside the container"
+cmd_prefix bash -c "pip3 list"
+
+echo
+echo "# State of the containers"
+docker ps -a
 
 if [[ -f $POST_BEFORE_SCRIPT ]]; then
   source $POST_BEFORE_SCRIPT
 fi
 
-# Lots of plugins try to use this path, and throw warnings if they cannot access it.
-cmd_prefix mkdir /.pytest_cache
-cmd_prefix chown pulp:pulp /.pytest_cache

templates/github/.github/workflows/scripts/install.sh.j2

@@ -2,12 +2,12 @@
 
 {% include 'header.j2' %}
 
+set -euv
+
 # make sure this script runs at the repo root
 cd "$(dirname "$(realpath -e "$0")")"/../../..
 REPO_ROOT="$PWD"
 
-set -euv
-
 source .github/workflows/scripts/utils.sh
 
 PLUGIN_VERSION="$(bump-my-version show current_version | tail -n -1 | python -c 'from packaging.version import Version; print(Version(input()))')"
@@ -227,6 +227,18 @@ if [[ "$TEST" = "azure" ]]; then
   az storage container create --name pulp-test --connection-string $AZURE_STORAGE_CONNECTION_STRING
 fi
 
-echo ::group::PIP_LIST
-cmd_prefix bash -c "pip3 list"
-echo ::endgroup::
+# Needed for some functional tests
+cmd_prefix bash -c "echo '%wheel        ALL=(ALL)       NOPASSWD: ALL' > /etc/sudoers.d/nopasswd"
+cmd_prefix bash -c "usermod -a -G wheel pulp"
+{%- if disabled_redis_runners %}
+
+# In some scenarios we want to simulate a failed redis cache.
+if [[ " {{ " ".join(disabled_redis_runners) }} " =~ " ${TEST} " ]]; then
+  cmd_prefix bash -c "s6-rc -d change redis"
+  echo "The Redis service was disabled for $TEST"
+fi
+{%- endif %}
+
+# Lots of plugins try to use this path, and throw warnings if they cannot access it.
+cmd_prefix mkdir /.pytest_cache
+cmd_prefix chown pulp:pulp /.pytest_cache

templates/github/.github/workflows/test.yml.j2

@@ -75,7 +75,7 @@ jobs:
 
       {{ run_script(name="Install", file="install.sh") | indent(6) }}
 
-      {{ run_script(name="Before Script", file="before_script.sh", extra_env={"REDIS_DISABLED": "${{ contains('%s', matrix.env.TEST) }}" % (disabled_redis_runners | default(["TILT"]) | join(' '))}) | indent(6) }}
+      {{ run_script(name="Dump CI Metadata", file="before_script.sh") | indent(6) }}
 
       {{ run_script(name="Script", file="script.sh") | indent(6) }}
       {%- if test_deprecations %}