feat: publish startup warnings for deployment checks #4739
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| #!/bin/sh | ||
| set -eu | ||
|
|
||
| report=${WEBLATE_DOCKER_WARNING_REPORT:-} | ||
| hostname=${WEBLATE_DOCKER_WARNING_HOSTNAME:-unknown} | ||
| service=${WEBLATE_DOCKER_WARNING_SERVICE:-all} | ||
| warnings=${WEBLATE_DOCKER_WARNING_MESSAGES:-} | ||
| sleep_pid= | ||
| if [ -z "$report" ]; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| initialize_report() { | ||
| mkdir -p "$report" | ||
| printf '%s\n' "$hostname" > "$report/hostname" | ||
| printf '%s\n' "$service" > "$report/service" | ||
| printf '%s' "$warnings" > "$report/warnings" | ||
| touch "$report/heartbeat" "$report" | ||
| } | ||
|
|
||
| cleanup_report() { | ||
| if [ -n "$sleep_pid" ]; then | ||
| kill "$sleep_pid" 2> /dev/null || true | ||
| fi | ||
| rm -f -- \ | ||
| "$report/heartbeat" \ | ||
| "$report/hostname" \ | ||
| "$report/service" \ | ||
| "$report/warnings" || true | ||
| rmdir -- "$report" 2> /dev/null || true | ||
| } | ||
|
|
||
| shutdown() { | ||
| cleanup_report | ||
| exit 0 | ||
| } | ||
|
|
||
| trap shutdown HUP INT TERM | ||
| initialize_report | ||
|
|
||
| while :; do | ||
| touch "$report/heartbeat" "$report" | ||
| sleep 60 & | ||
| sleep_pid=$! | ||
| wait "$sleep_pid" | ||
| sleep_pid= | ||
| done |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| [program:docker-warning-heartbeat] | ||
| command = /app/bin/docker_warning_heartbeat | ||
| autorestart = true | ||
| stopasgroup = true | ||
| killasgroup = true | ||
| stdout_logfile=/dev/fd/1 | ||
| stdout_logfile_maxbytes=0 | ||
| redirect_stderr=true | ||
| priority = 50 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,32 @@ | ||
| #!/bin/sh | ||
|
|
||
| OUTPUT=$(docker compose exec -T \ | ||
| --user weblate \ | ||
| weblate weblate check --deploy --fail-level WARNING 2>&1) | ||
| RESULT=$? | ||
|
|
||
| SUPPORTS_DOCKER_WARNINGS=0 | ||
| if docker compose exec -T \ | ||
| --user weblate \ | ||
| weblate /app/venv/bin/python -c \ | ||
| 'from weblate.utils.checks import DOC_LINKS; raise SystemExit("weblate.W049" not in DOC_LINKS)'; then | ||
| SUPPORTS_DOCKER_WARNINGS=1 | ||
| fi | ||
|
|
||
| if [ "${1:-}" = "celery-single-legacy" ] && [ "$SUPPORTS_DOCKER_WARNINGS" -eq 1 ]; then | ||
| if [ "$RESULT" -eq 0 ]; then | ||
| echo "Docker startup warning did not affect the deployment check" >&2 | ||
| exit 1 | ||
| fi | ||
| if ! echo "$OUTPUT" | grep -F "weblate.W049" > /dev/null; then | ||
| echo "$OUTPUT" >&2 | ||
| exit 1 | ||
| fi | ||
| if ! echo "$OUTPUT" | grep -F "CELERY_SINGLE_PROCESS is deprecated" > /dev/null; then | ||
| echo "$OUTPUT" >&2 | ||
| exit 1 | ||
| fi | ||
| elif [ "$RESULT" -ne 0 ]; then | ||
| echo "$OUTPUT" >&2 | ||
| exit "$RESULT" | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| #!/bin/sh | ||
| set -eu | ||
|
|
||
| SCRIPT_DIR=$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd) | ||
| DOCKER_ROOT=$(CDPATH='' cd -- "$SCRIPT_DIR/../.." && pwd) | ||
| TEST_ROOT=$(mktemp -d) | ||
| REPORT="$TEST_ROOT/report" | ||
|
|
||
| run_heartbeat() { | ||
| WEBLATE_DOCKER_WARNING_HOSTNAME=test-host \ | ||
| WEBLATE_DOCKER_WARNING_MESSAGES="Test warning" \ | ||
| WEBLATE_DOCKER_WARNING_REPORT="$REPORT" \ | ||
| WEBLATE_DOCKER_WARNING_SERVICE=test-service \ | ||
| "$DOCKER_ROOT/docker_warning_heartbeat" & | ||
| HEARTBEAT_PID=$! | ||
| } | ||
|
|
||
| wait_for_heartbeat() { | ||
| ATTEMPTS=0 | ||
| while [ ! -f "$REPORT/heartbeat" ]; do | ||
| if ! kill -0 "$HEARTBEAT_PID" 2> /dev/null; then | ||
| wait "$HEARTBEAT_PID" | ||
| echo "Docker startup warning heartbeat exited before initialization" >&2 | ||
| exit 1 | ||
| fi | ||
| ATTEMPTS=$((ATTEMPTS + 1)) | ||
| if [ "$ATTEMPTS" -ge 50 ]; then | ||
| kill -TERM "$HEARTBEAT_PID" | ||
| wait "$HEARTBEAT_PID" | ||
| echo "Docker startup warning heartbeat was not initialized" >&2 | ||
| exit 1 | ||
| fi | ||
| sleep 0.1 | ||
| done | ||
| } | ||
|
|
||
| stop_heartbeat() { | ||
| kill -TERM "$HEARTBEAT_PID" | ||
| wait "$HEARTBEAT_PID" | ||
| } | ||
|
|
||
| assert_report_removed() { | ||
| if [ -d "$REPORT" ]; then | ||
| echo "Docker startup warning report was not removed on shutdown" >&2 | ||
| exit 1 | ||
| fi | ||
| } | ||
|
|
||
| run_heartbeat | ||
| wait_for_heartbeat | ||
| grep -Fx "Test warning" "$REPORT/warnings" | ||
| stop_heartbeat | ||
| assert_report_removed | ||
|
|
||
| # Supervisord can restart the heartbeat helper without rerunning the entrypoint. | ||
| run_heartbeat | ||
| wait_for_heartbeat | ||
| grep -Fx "Test warning" "$REPORT/warnings" | ||
| stop_heartbeat | ||
| assert_report_removed | ||
| rmdir "$TEST_ROOT" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the shared data volume is reused by containers running different arbitrary UIDs, as supported for OpenShift-style deployments, the first
mkdir -pcreates.docker-startup-warningswith the normal0755mode and ownership of that container's UID. A later container with another UID but the shared root group cannot create its report beneath that directory, so this path prints the initialization error and silently disables warning publication and stale-report cleanup. Create the shared root with group-write permissions consistent with/app/databefore creating the per-container directory.Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we actually support such setups.