File: go_test_with_coverage_report

package info (click to toggle)
gitlab-ci-multi-runner 14.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 31,248 kB
  • sloc: sh: 1,694; makefile: 384; asm: 79; ruby: 68
file content (203 lines) | stat: -rwxr-xr-x 5,532 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
#!/usr/bin/env bash

set -eo pipefail

testsDefinitions=${TESTSDEFINITIONSPATH:-"testsdefinitions.txt"}

TESTFLAGS=${TESTFLAGS:-"-cover"}
PARALLEL_TESTS_LIMIT=${PARALLEL_TESTS_LIMIT:-10}

CI_NODE_TOTAL=${CI_NODE_TOTAL:-1}
CI_NODE_INDEX=${CI_NODE_INDEX:-1}

output="regular"
coverMode="count"

if [[ ${TESTFLAGS} = *"-race"* ]]; then
    output="race"
    coverMode="atomic"
fi

printMessage() {
  echo -e "\\033[1m${*}\\033[0m"
}

joinBy() {
    local IFS="${1}"
    shift
    echo "${*}"
}

prepareTestCommands() {
    local definitions

    [[ ! -f ${testsDefinitions} ]] || rm ${testsDefinitions}

    for pkg in $(go list ./...); do
        local testIndex=0
        local runTests=()

        echo "Listing tests for ${pkg} package"

        local tempFile
        tempFile=$(mktemp)
        local exitCode=0

        # use env -i to clear parent environment variables for go test
        # shellcheck disable=SC2086
        ./scripts/go_test_no_env ${TESTFLAGS} -list "Test.*" "${pkg}" > "${tempFile}" || exitCode=99

        local tests
        tests=$(grep "^Test" "${tempFile}" || true)

        rm "${tempFile}"

        if [[ ${exitCode} -ne 0 ]]; then
            exit ${exitCode}
        fi

        if [[ -z "${tests}" ]]; then
            continue
        fi

        local counter=0
        for test in ${tests}; do
            counter=$((counter+1))
            runTests+=("${test}")

            if [[ ${counter} -ge ${PARALLEL_TESTS_LIMIT} ]]; then
                if [[ ${#runTests[@]} -gt 0 ]]; then
                    definitions=$(joinBy "|" "${runTests[@]}")
                    echo "${pkg} ${testIndex} ${definitions}" | tee -a ${testsDefinitions}
                fi

                counter=0
                runTests=()

                testIndex=$((testIndex+1))
            fi
        done

        if [[ ${#runTests[@]} -gt 0 ]]; then
            definitions=$(joinBy "|" "${runTests[@]}")
            echo "${pkg} ${testIndex} ${definitions}" | tee -a ${testsDefinitions}
        fi
    done
}

executeTestCommand() {
    local pkg=${1}
    local index=${2}
    local runTestsList=${3}

    local options=""

    local pkgSlug
    pkgSlug=$(echo "${pkg}" | tr "/" "-")

    local type
    if [[ ${TESTFLAGS} = *'tags=integration'* ]]; then
        type="integration"
    else
        type="unit"
    fi

    if [[ ${TESTFLAGS} = *'-cover'* ]]; then
        mkdir -p ".cover/${type}"
        mkdir -p ".testoutput/${type}"

        printMessage "\\n\\n--- Starting part ${index} of go ${type} tests of '${pkg}' package with coverprofile in '${coverMode}' mode:\\n"

        local profileFile=".cover/${type}/${pkgSlug}.${index}.${coverMode}.cover.txt"
        options="-covermode=${coverMode} -coverprofile=${profileFile} -coverpkg=${MAIN_PACKAGE}/..."
    else
        echo "Starting go ${type} test"
    fi

    local testOutputFile=".testoutput/${type}/${pkgSlug}.${index}.${output}.output.txt"

    local exitCode=0

    # use env -i to clear parent environment variables for go test
    # shellcheck disable=SC2086
    ./scripts/go_test_no_env ${options} ${TESTFLAGS} -ldflags "${GO_LDFLAGS}" -v "${pkg}" -run "${runTestsList}" 2>&1 | tee "${testOutputFile}" || exitCode=99

    return ${exitCode}
}

executeTestPart() {
    rm -rf .cover/ .testoutput/

    local numberOfDefinitions
    numberOfDefinitions=$(< "${testsDefinitions}" wc -l)
    local executionSize
    executionSize=$((numberOfDefinitions/CI_NODE_TOTAL+1))
    local nodeIndex=$((CI_NODE_INDEX-1))
    local executionOffset
    executionOffset=$((nodeIndex*executionSize+1))

    printMessage "Number of definitions: ${numberOfDefinitions}"
    printMessage "Suite size: ${CI_NODE_TOTAL}"
    printMessage "Suite index: ${CI_NODE_INDEX}"

    printMessage "Execution size: ${executionSize}"
    printMessage "Execution offset: ${executionOffset}"

    local exitCode=0
    while read -r pkg index tests; do
        executeTestCommand "${pkg}" "${index}" "${tests}" || exitCode=99
    done < <(tail -n +${executionOffset} ${testsDefinitions} | head -n ${executionSize})

    exit ${exitCode}
}

computeCoverageReport() {
    local reportDirectory="out/coverage"
    local sourceFile="${reportDirectory}/coverprofile.${output}.source.txt"
    local htmlReportFile="${reportDirectory}/coverprofile.${output}.html"
    local textReportFile="${reportDirectory}/coverprofile.${output}.txt"

    mkdir -p "${reportDirectory}"

    echo "mode: ${coverMode}" > ${sourceFile}
    grep -h -v -E -e "^mode:" -e "\/mock_[^\.]+\.go" .cover/*/*.${coverMode}.cover.txt >> ${sourceFile}

    printMessage "Generating HTML coverage report"
    go tool cover -o ${htmlReportFile} -html=${sourceFile}
    printMessage "Generating TXT coverage report"
    go tool cover -o ${textReportFile} -func=${sourceFile}

    printMessage "General coverage percentage:"
    local total
    total=$(grep "total" "${textReportFile}" || echo "")

    if [[ -n "${total}" ]]; then
        echo "${output} ${total}"
    fi
}

computeJUnitReport() {
    local reportDirectory="out/junit"
    local concatenatedOutputFile="/tmp/test-output.txt"

    mkdir -p "${reportDirectory}"

    cat .testoutput/*/*.${output}.output.txt > "${concatenatedOutputFile}"

    go-junit-report < "${concatenatedOutputFile}" > "${reportDirectory}/report.xml"
}

case "$1" in
    prepare)
        prepareTestCommands
        ;;
    execute)
        executeTestPart
        ;;
    coverage)
        computeCoverageReport
        ;;
    junit)
        computeJUnitReport
        ;;
esac