charts/githooks/functions/libyamllint.sh

#!/bin/bash

render_and_yaml_lint_full() {
    local -r chart_path="${1:?missing_chart}"
    local -r values="${2:?missing_values}"
    local -r repo_path="$(git rev-parse --show-toplevel)"
    local -r display_chart_path=${chart_path#"$repo_path/"}
    local -r display_values=${values#"$repo_path/"}
    local -r lint_rules="{extends: default, rules: {line-length: disable, trailing-spaces: disable, truthy: enable, document-start: disable, empty-lines: {max-end: 2} }}"

    local -r helm_version="$(helm version --template={{.Version}})"
    local -r helm_three="^v3.*"
    local rendered_template

    if [[ "$helm_version" =~ $helm_three ]]; then
        rendered_template=$(helm template --values "$values" "$chart_path" 2> /dev/null)
    else
        rendered_template=$(helm template --values "$values" "$chart_path" 2> /dev/null)
    fi

    if ! echo "$rendered_template" | yamllint -s -d "$lint_rules" - > /dev/null 2>&1; then
        printf '\033[0;31m\U0001F6AB (helm template --values %s | yamllint -s -d "%s" -) failed\n\033[0m' "$display_values" "$display_chart_path""$lint_rules"
        false
    else
        true
    fi
}

render_and_yaml_lint_file() {
    local -r chart_path="${1:?missing_chart}"
    local -r path="${2:?missing_file}"
    local -r values="${3:?missing_values}"
    local -r repo_path="$(git rev-parse --show-toplevel)"
    local -r display_chart_path=${chart_path#"$repo_path/"}
    local -r display_values=${values#"$repo_path/"}
    local -r basename_template_path=${path#"$chart_path/"}
    local -r lint_rules="{extends: default, rules: {line-length: disable, trailing-spaces: disable, truthy: enable, document-start: disable, empty-lines: {max-end: 2} }}"
    # printf '\033[0;34m- Running yamllint on %s/%s (values: %s)\n\033[0m' "$display_chart_path" "$basename_template_path" "$display_values"

    local -r helm_version="$(helm version --template={{.Version}})"
    local -r helm_three="^v3.*"
    local rendered_template

    if [[ "$helm_version" =~ $helm_three ]]; then
        rendered_template=$(helm template --values "$values" "$chart_path" -s "$basename_template_path" 2> /dev/null)
    else
        rendered_template=$(helm template --values "$values" "$chart_path" -x "$basename_template_path" 2> /dev/null)
    fi

    if ! echo "$rendered_template" | yamllint -s -d "$lint_rules" -; then
        printf '\033[0;31m\U0001F6AB (helm template --values %s %s -s %s | yamllint -s -d "%s" -) failed\n\033[0m' "$display_values" "$display_chart_path" "$basename_template_path" "$lint_rules"
        false
    else
        true
    fi
}

yaml_lint_file() {
    local -r path="${1:?missing_file}"
    local -r lint_rules="{extends: default, rules: { line-length: disable, trailing-spaces: disable, truthy: enable, document-start: disable, empty-lines: {max-end: 2}}}"
    local -r repo_path="$(git rev-parse --show-toplevel)"
    local -r display_path=${path#"$repo_path/"}
    # printf '\033[0;34m- Running yamllint on %s\n' "$display_path"
    if ! yamllint -s -d "$lint_rules" "$path"; then
        printf '\033[0;31m\U0001F6AB yamllint -s -d "%s" %s failed\n\033[0m' "$lint_rules" "$display_path"
        false
    else
        true
    fi
}

check_yaml_lint() {
    if ! command -v yamllint > /dev/null 2>&1; then
        printf '\033[0;31m\U0001F6AB yamllint is not installed\033[0m'
        printf '  Installation for Linux'
        printf '    pip install --user yamllint'
        printf '  Installation for Mac OS'
        printf '    brew install yamllint'
        exit 1
    fi
}

run_yaml_lint_chart() {
    local -r chart_name="${1:?missing_chart_name}"
    local -r chart_path="$(git rev-parse --show-toplevel)"/"$chart_name"
    local test_failed=0
    printf '\033[0;34m- Running yamllint on %s\n' "$chart_name"

    local -r ci_values_file_list=$(mktemp)
    local -r template_yaml_file_list=$(mktemp)

    if [[ -d "$chart_path"/ci ]]; then
        find "$chart_path"/ci -type f -regex ".*\.yaml" > "$ci_values_file_list"
    fi
    find "$chart_path"/templates -type f -regex ".*\.yaml" > "$template_yaml_file_list"

    for yaml_file in "$chart_path"/values.yaml "$chart_path"/values-production.yaml "$chart_path"/requirements.yaml "$chart_path"/Chart.yaml $(< "$ci_values_file_list"); do
        if [[ -f "$yaml_file" ]] && ! yaml_lint_file "$yaml_file"; then
            test_failed=1
        fi
    done

    for values_file in "$chart_path"/values.yaml $(< "$ci_values_file_list"); do
        if [[ ! -f "$values_file" ]];then
            continue
        fi
        if ! render_and_yaml_lint_full "$chart_path"  "$values_file"; then
            printf '\033[0;31m\U0001F6AB Going file by file to get the cause of the issue'
            for yaml_file in $(< "$template_yaml_file_list"); do
                if ! render_and_yaml_lint_file "$chart_path" "$yaml_file" "$values_file"; then
                    test_failed=1
                fi
            done
        fi
    done

    rm "$ci_values_file_list"
    rm "$template_yaml_file_list"

    if [[ "$test_failed" = "1" ]]; then
        false
    else
        printf '\033[0;32m\U00002705 Yaml lint %s\n\033[0m' "$chart_name"
        true
    fi
}