aboutsummaryrefslogtreecommitdiffstats
path: root/tools/cover.sh
blob: c6e928d1a145f342ec7dcf89ff7d66609e5f0502 (plain)
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
#!/bin/bash
##############################################################################
# Copyright 2015: Mirantis Inc.
# All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.
# yardstick comment: this is a modified copy of
# rally/tests/ci/cover.sh
##############################################################################

if [[ -n $COVER_DIR_NAME ]]; then
    :
elif [[ -n $_ ]]; then
    COVER_DIR_NAME=$( dirname $_ )
else
    COVER_DIR_NAME=$( dirname $0 )
fi

show_diff () {
    diff -U 0 $1 $2 | awk -f $COVER_DIR_NAME/cover.awk
}

run_coverage_test() {

    ALLOWED_EXTRA_MISSING=10
    # enable debugging
    set -x

    # Stash uncommitted changes, checkout master and save coverage report
    uncommited=$(git status --porcelain | grep -v "^??")
    [[ -n ${uncommited} ]] && git stash > /dev/null
    git checkout HEAD^

    baseline_report=$(mktemp -t yardstick_coverageXXXXXXX)

    find . -type f -name "*.pyc" -delete

    # Temporarily run tests from two directories, until all tests have moved
    coverage run -p -m unittest discover ./tests/unit
    coverage run -p -m unittest discover ./yardstick/tests/unit
    coverage combine

    # Temporarily omit yardstick/tests from the report
    coverage report --omit=yardstick/tests/*/* > ${baseline_report}
    coverage erase

    # debug awk
    tail -1 ${baseline_report}
    baseline_missing=$(awk 'END { if (int($3) > 0) print $3 }' ${baseline_report})

    if [[ -z $baseline_missing ]]; then
        echo "Failed to determine baseline missing"
        exit 1
    fi

    # Checkout back and unstash uncommitted changes (if any)
    git checkout -
    [[ -n ${uncommited} ]] && git stash pop > /dev/null

    # Generate and save coverage report
    current_report=$(mktemp -t yardstick_coverageXXXXXXX)

    find . -type f -name "*.pyc" -delete

    # Temporarily run tests from two directories, until all tests have moved
    coverage run -p -m unittest discover ./tests/unit
    coverage run -p -m unittest discover ./yardstick/tests/unit
    coverage combine

    # Temporarily omit yardstick/tests from the report
    coverage report --omit=yardstick/tests/*/* > ${current_report}
    coverage erase

    rm -rf cover-$PY_VER
    coverage html -d cover-$PY_VER

    # debug awk
    tail -1 ${current_report}
    current_missing=$(awk 'END { if (int($3) > 0) print $3 }' ${current_report})

    if [[ -z $current_missing ]]; then
        echo "Failed to determine current missing"
        exit 1
    fi

    # Show coverage details
    new_missing=$((current_missing - baseline_missing))

    echo "Missing lines allowed to introduce : ${ALLOWED_EXTRA_MISSING}"
    echo "Missing lines introduced           : ${new_missing}"
    echo "Missing lines in master            : ${baseline_missing}"
    echo "Missing lines in proposed change   : ${current_missing}"

    if [[ ${new_missing} -gt ${ALLOWED_EXTRA_MISSING} ]];
    then
        show_diff ${baseline_report} ${current_report}
        echo "Please write more unit tests, we should keep our test coverage :( "
        rm ${baseline_report} ${current_report}
        exit 1

    elif [[ ${new_missing} -gt 0 ]];
    then
        show_diff ${baseline_report} ${current_report}
        echo "I believe you can cover all your code with 100% coverage!"

    else
        echo "Thank you! You are awesome! Keep writing unit tests! :)"
    fi

    rm ${baseline_report} ${current_report}
}