Skip to content

Robertomonteromiguel/gitlab collapsible sections #7095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
robertomonteromiguel wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Robertomonteromiguel/gitlab collapsible sections #7095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33c69a5
SSI Refactor: extract GitLab CI log-rendering into a reusable script
robertomonteromiguel Jun 5, 2026
55ceffd
SSI Refactor: extract GitLab CI log-rendering into a reusable script
robertomonteromiguel Jun 5, 2026
5f06c7d
fix k8s
robertomonteromiguel Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 28 additions & 39 deletions .gitlab/ssi_gitlab-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ ssi_tests:
else
echo "No reports/logs*/reportJunit.xml found; skipping Test Optimization upload"
fi

# Render all report logs as collapsible sections + run summary + banner.
if [ "$CI_PROJECT_NAME" = "system-tests" ]; then
SCRIPTS_DIR="./utils/scripts"
else
SCRIPTS_DIR="./system-tests/utils/scripts"
fi
export SCENARIO_SUFIX
bash "${SCRIPTS_DIR}/gitlab_print_logs.sh"
retry:
max: 2
when:
Expand Down Expand Up @@ -128,10 +137,10 @@ ssi_tests:
# all relative paths into the system-tests repo need that prefix.
if [ "$CI_PROJECT_NAME" = "system-tests" ]; then
LOGS_FOLDER="logs_${SCENARIO_SUFIX}"
COLLAPSIBLE_LOGS_SCRIPT="./utils/scripts/gitlab_collapsible_logs.sh"
SCRIPTS_DIR="./utils/scripts"
else
LOGS_FOLDER="system-tests/logs_${SCENARIO_SUFIX}"
COLLAPSIBLE_LOGS_SCRIPT="./system-tests/utils/scripts/gitlab_collapsible_logs.sh"
SCRIPTS_DIR="./system-tests/utils/scripts"
fi
# Upload to S3 (the URL is printed once at the end of the after_script).
AWS_CONSOLE_URL=""
Expand Down Expand Up @@ -165,42 +174,9 @@ ssi_tests:
done
fi

# Dump every log file as a collapsible section (full content).
if [ -f "${COLLAPSIBLE_LOGS_SCRIPT}" ]; then
while IFS= read -r -d '' file; do
section_id=$(printf '%s' "$file" | tr -c '[:alnum:]' '_')
bash "${COLLAPSIBLE_LOGS_SCRIPT}" "$file" "logs_${SCENARIO_SUFIX}_${section_id}" "Logs for ${SCENARIO_SUFIX} - ${file}"
done < <(find reports -type f \! -name report.json \! -name tests.log -print0)
else
echo "Skipping collapsible log dump: ${COLLAPSIBLE_LOGS_SCRIPT} not found"
fi

# Re-print the captured run.sh summary at the END
if [ -f "${CI_PROJECT_DIR}/run_output.log" ]; then
printf '\n%s\n Test run summary (captured from script: step)\n%s\n\n' \
"================================================================================" \
"================================================================================"
tail -c 200000 "${CI_PROJECT_DIR}/run_output.log"
fi

# Final info banner with everything the user needs to navigate the log.
printf '\n%s\n Logs for %s\n%s\n' \
"================================================================================" \
"${SCENARIO_SUFIX}" \
"--------------------------------------------------------------------------------"
printf ' - Each log file above is wrapped in its own collapsible section.\n'
printf ' Click the triangle on the section header to expand/collapse it.\n'
printf ' - If some sections appear uncollapsed in this view, click\n'
printf ' "View full log" To view all collapsed sections (all logs)\n'
printf ' - You can always download the logs attached to the job\n'
if [ -n "${AWS_CONSOLE_URL}" ]; then
printf ' - Full raw logs (including files >50MB stripped from the artifact)\n'
printf ' are uploaded to S3:\n %s\n' "${AWS_CONSOLE_URL}"
fi
printf ' - How to interpret these logs:\n %s\n' \
"https://github.com/DataDog/system-tests/blob/main/docs/understand/scenarios/onboarding.md#how-to-debug-your-environment-and-tests-results"
printf '%s\n\n' \
"================================================================================"
# Render all report logs as collapsible sections + run summary + banner.
export SCENARIO_SUFIX AWS_CONSOLE_URL
bash "${SCRIPTS_DIR}/gitlab_print_logs.sh"

retry:
max: 2
Expand Down Expand Up @@ -245,7 +221,11 @@ ssi_tests:
else
TAG_NAME="latest"
fi
- ./run.sh ${K8S_SCENARIO} --k8s-library ${TEST_LIBRARY} --k8s-weblog ${K8S_WEBLOG} --k8s-weblog-img ${K8S_WEBLOG_IMG}:${TAG_NAME} --k8s-lib-init-img ${K8S_LIB_INIT_IMG} --k8s-injector-img ${K8S_INJECTOR_IMG:-None} --k8s-cluster-img ${K8S_CLUSTER_IMG:-None} --report-run-url $CI_JOB_URL --report-environment ${REPORT_ENVIRONMENT}
- |
# Run the tests and capture stdout+stderr so the after_script can
# re-print the run summary (pipefail keeps run.sh's real exit code).
set -o pipefail
./run.sh ${K8S_SCENARIO} --k8s-library ${TEST_LIBRARY} --k8s-weblog ${K8S_WEBLOG} --k8s-weblog-img ${K8S_WEBLOG_IMG}:${TAG_NAME} --k8s-lib-init-img ${K8S_LIB_INIT_IMG} --k8s-injector-img ${K8S_INJECTOR_IMG:-None} --k8s-cluster-img ${K8S_CLUSTER_IMG:-None} --report-run-url $CI_JOB_URL --report-environment ${REPORT_ENVIRONMENT} 2>&1 | tee "${CI_PROJECT_DIR}/run_output.log"

after_script: |
kind delete clusters --all || true
Expand All @@ -269,6 +249,15 @@ ssi_tests:
done
done
fi

# Render all report logs as collapsible sections + run summary + banner.
if [ "$CI_PROJECT_NAME" = "system-tests" ]; then
SCRIPTS_DIR="./utils/scripts"
else
SCRIPTS_DIR="./system-tests/utils/scripts"
fi
export SCENARIO_SUFIX=$(echo "${K8S_SCENARIO:-logs}" | tr "[:upper:]" "[:lower:]")
bash "${SCRIPTS_DIR}/gitlab_print_logs.sh"
retry:
max: 2
when:
Expand Down
58 changes: 58 additions & 0 deletions utils/scripts/gitlab_print_logs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#!/bin/bash
#
# Render a job's logs at the END of a GitLab CI after_script:
# 1. Dump every file under reports/ as its own collapsible section.
# 2. Re-print the captured run.sh summary (when available).
# 3. Print a final banner explaining how to navigate the logs.
#
# Shared by the SSI / onboarding / k8s jobs so the logic lives in one place.
#
# Optional environment variables:
# SCENARIO_SUFIX Label shown in the section headers (defaults to "logs").
# CI_PROJECT_DIR GitLab built-in; used to locate run_output.log.
# AWS_CONSOLE_URL S3 console URL printed in the banner when set.

set -uo pipefail

# The collapsible-section helper lives next to this script.
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
COLLAPSIBLE_LOGS_SCRIPT="${SCRIPT_DIR}/gitlab_collapsible_logs.sh"

LABEL="${SCENARIO_SUFIX:-logs}"

# 1. Dump every log file as a collapsible section (full content).
if [ -f "${COLLAPSIBLE_LOGS_SCRIPT}" ]; then
while IFS= read -r -d '' file; do
section_id=$(printf '%s' "$file" | tr -c '[:alnum:]' '_')
bash "${COLLAPSIBLE_LOGS_SCRIPT}" "$file" "logs_${LABEL}_${section_id}" "Logs for ${LABEL} - ${file}"
done < <(find reports -type f \! -name report.json \! -name tests.log -print0)
else
echo "Skipping collapsible log dump: ${COLLAPSIBLE_LOGS_SCRIPT} not found"
fi

# 2. Re-print the captured run.sh summary at the END.
if [ -n "${CI_PROJECT_DIR:-}" ] && [ -f "${CI_PROJECT_DIR}/run_output.log" ]; then
printf '\n%s\n Test run summary (captured from script: step)\n%s\n\n' \
"================================================================================" \
"================================================================================"
tail -c 200000 "${CI_PROJECT_DIR}/run_output.log"
fi

# 3. Final info banner with everything the user needs to navigate the log.
printf '\n%s\n Logs for %s\n%s\n' \
"================================================================================" \
"${LABEL}" \
"--------------------------------------------------------------------------------"
printf ' - Each log file above is wrapped in its own collapsible section.\n'
printf ' Click the triangle on the section header to expand/collapse it.\n'
printf ' - If some sections appear uncollapsed in this view, click\n'
printf ' "View full log" To view all collapsed sections (all logs)\n'
printf ' - You can always download the logs attached to the job\n'
if [ -n "${AWS_CONSOLE_URL:-}" ]; then
printf ' - Full raw logs (including files >50MB stripped from the artifact)\n'
printf ' are uploaded to S3:\n %s\n' "${AWS_CONSOLE_URL}"
fi
printf ' - How to interpret these logs:\n %s\n' \
"https://github.com/DataDog/system-tests/blob/main/docs/understand/scenarios/onboarding.md#how-to-debug-your-environment-and-tests-results"
printf '%s\n\n' \
"================================================================================"
Loading