Skip to content

Report hard lint failures even when another chart only warns #944

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

Open
michaellzc wants to merge 1 commit into
base: marc/fix-ci-lint-script
Choose a base branch
from
+45 −6
Open

Report hard lint failures even when another chart only warns #944

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 45 additions & 6 deletions scripts/ci/lint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

set -euf -o pipefail

# Exit status used to signal "lint succeeded but emitted warnings". The Buildkite
# lint step soft-fails on this status, so it must never be used to report a chart
# that actually failed to lint.
WARNING_EXIT_STATUS=255

# Highest-severity outcome seen so far. A hard lint failure always wins over a
# warning, so a warning in an earlier chart can never downgrade a later failure
# into a soft fail.
hard_status=0
warned=0
results=()

### Run the helm tests
function lint_chart() {
local chart_path="$1"
Expand All @@ -19,34 +31,61 @@ function lint_chart() {

printf "\n\n===== Lint Output: %s =====\n%s\n" "${chart_path}" "${lint_output}"

# A chart that failed to lint is reported as a failure even if it also emitted
# warnings, otherwise the failure would be masked by the soft-failed status.
if [ "${lint_status}" -ne 0 ]; then
printf "Helm lint failed for %s\n" "${chart_path}" >&2
return "${lint_status}"
fi

if grep -qi "warning" <<<"${lint_output}"; then
printf "Helm lint emitted warnings for %s\n" "${chart_path}" >&2
return 255
return "${WARNING_EXIT_STATUS}"
fi

return "${lint_status}"
return 0
}

function lint_and_record() {
local chart_path="$1"
local chart_status

if lint_chart "$@"; then
results+=("PASS ${chart_path}")
return 0
else
chart_status=$?
fi

if [ "${exit_status}" -eq 0 ]; then
exit_status="${chart_status}"
if [ "${chart_status}" -eq "${WARNING_EXIT_STATUS}" ]; then
warned=1
results+=("WARNING ${chart_path}")
else
results+=("FAIL ${chart_path} (helm lint exited ${chart_status})")
if [ "${hard_status}" -eq 0 ]; then
hard_status="${chart_status}"
fi
fi

return 0
}

exit_status=0
lint_and_record "charts/sourcegraph"
lint_and_record "charts/sourcegraph-migrator"
lint_and_record "charts/sourcegraph-executor/k8s" --set "executor.queueName=batches"
lint_and_record "charts/sourcegraph-executor/dind" --set "executor.queueName=batches"

exit "${exit_status}"
printf "\n\n===== Lint Summary =====\n"
printf "%s\n" "${results[@]}"

if [ "${hard_status}" -ne 0 ]; then
printf "\nOne or more charts failed to lint\n" >&2
exit "${hard_status}"
fi

if [ "${warned}" -ne 0 ]; then
printf "\nOne or more charts emitted lint warnings\n" >&2
exit "${WARNING_EXIT_STATUS}"
fi

exit 0
Loading