Coverage for tests / test_results.py: 100.000%

1# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 

2# For details: https://github.com/coveragepy/coveragepy/blob/main/NOTICE.txt 

3 

4"""Tests for coverage.py's results analysis.""" 

5 

6from __future__ import annotations 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

7 

8import math 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

9 

10from typing import cast 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

11from collections.abc import Iterable 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

12 

13import pytest 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

14 

15from coverage.exceptions import ConfigError 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

16from coverage.results import Numbers, display_covered, format_lines, should_fail_under 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

17from coverage.types import TLineNo 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

18 

19from tests.coveragetest import CoverageTest 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

20 

21 

22class NumbersTest(CoverageTest): 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

23 """Tests for coverage.py's numeric measurement summaries.""" 

24 

25 run_in_temp_dir = False 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

26 

27 def test_basic(self) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

28 n1 = Numbers(n_files=1, n_statements=200, n_missing=20) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

29 assert n1.n_statements == 200 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

30 assert n1.n_executed == 180 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

31 assert n1.n_missing == 20 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

32 assert n1.pc_covered == 90 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

33 

34 def test_addition(self) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

35 n1 = Numbers(n_files=1, n_statements=200, n_missing=20) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

36 n2 = Numbers(n_files=1, n_statements=10, n_missing=8) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

37 n3 = n1 + n2 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

38 assert n3.n_files == 2 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

39 assert n3.n_statements == 210 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

40 assert n3.n_executed == 182 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

41 assert n3.n_missing == 28 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

42 assert math.isclose(n3.pc_covered, 86.666666666) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

43 

44 def test_sum(self) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

45 n1 = Numbers(n_files=1, n_statements=200, n_missing=20) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

46 n2 = Numbers(n_files=1, n_statements=10, n_missing=8) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

47 n3 = cast(Numbers, sum([n1, n2])) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

48 assert n3.n_files == 2 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

49 assert n3.n_statements == 210 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

50 assert n3.n_executed == 182 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

51 assert n3.n_missing == 28 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

52 assert math.isclose(n3.pc_covered, 86.666666666) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

53 

54 @pytest.mark.parametrize( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

55 "kwargs, res", 

56 [ 

57 (dict(n_files=1, n_statements=1000, n_missing=0), "100"), 

58 (dict(n_files=1, n_statements=1000, n_missing=1), "99"), 

59 (dict(n_files=1, n_statements=1000, n_missing=999), "1"), 

60 (dict(n_files=1, n_statements=1000, n_missing=1000), "0"), 

61 (dict(precision=1, n_files=1, n_statements=10000, n_missing=0), "100.0"), 

62 (dict(precision=1, n_files=1, n_statements=10000, n_missing=1), "99.9"), 

63 (dict(precision=1, n_files=1, n_statements=10000, n_missing=9999), "0.1"), 

64 (dict(precision=1, n_files=1, n_statements=10000, n_missing=10000), "0.0"), 

65 ], 

66 ) 

67 def test_pc_covered_str(self, kwargs: dict[str, int], res: str) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

68 assert Numbers(**kwargs).pc_covered_str == res 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

69 

70 @pytest.mark.parametrize( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

71 "prec, pc, res", 

72 [ 

73 (0, 47.87, "48"), 

74 (1, 47.87, "47.9"), 

75 (0, 99.995, "99"), 

76 (2, 99.99995, "99.99"), 

77 ], 

78 ) 

79 def test_display_covered(self, prec: int, pc: float, res: str) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

80 assert display_covered(pc, prec) == res 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

81 

82 def test_covered_ratio(self) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

83 n = Numbers(n_files=1, n_statements=200, n_missing=47) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

84 assert n.ratio_covered == (153, 200) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

85 

86 n = Numbers( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

87 n_files=1, 

88 n_statements=200, 

89 n_missing=47, 

90 n_branches=10, 

91 n_missing_branches=3, 

92 n_partial_branches=1000, 

93 ) 

94 assert n.ratio_statements == (153, 200) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

95 assert n.ratio_branches == (7, 10) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

96 assert n.ratio_covered == (160, 210) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

97 

98 

99@pytest.mark.parametrize( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

100 "total, fail_under, precision, result", 

101 [ 

102 # fail_under==0 means anything is fine! 

103 (0, 0, 0, False), 

104 (0.001, 0, 0, False), 

105 # very small fail_under is possible to fail. 

106 (0.001, 0.01, 0, True), 

107 # Rounding should work properly. 

108 (42.1, 42, 0, False), 

109 (42.1, 43, 0, True), 

110 (42.857, 42, 0, False), 

111 (42.857, 43, 0, False), 

112 (42.857, 44, 0, True), 

113 (42.857, 42.856, 3, False), 

114 (42.857, 42.858, 3, True), 

115 # If you don't specify precision, your fail-under is rounded. 

116 (42.857, 42.856, 0, False), 

117 # Values near 100 should only be treated as 100 if they are 100. 

118 (99.8, 100, 0, True), 

119 (100.0, 100, 0, False), 

120 (99.8, 99.7, 1, False), 

121 (99.88, 99.90, 2, True), 

122 (99.999, 100, 1, True), 

123 (99.999, 100, 2, True), 

124 (99.999, 100, 3, True), 

125 ], 

126) 

127def test_should_fail_under(total: float, fail_under: float, precision: int, result: bool) -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

128 assert should_fail_under(float(total), float(fail_under), precision) == result 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

129 

130 

131def test_should_fail_under_invalid_value() -> None: 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

132 with pytest.raises(ConfigError, match=r"fail_under=101"): 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

133 should_fail_under(100.0, 101, 0) 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

134 

135 

136@pytest.mark.parametrize( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

137 "statements, lines, result", 

138 [ 

139 ({1, 2, 3, 4, 5, 10, 11, 12, 13, 14}, {1, 2, 5, 10, 11, 13, 14}, "1-2, 5-11, 13-14"), 

140 ( 

141 [1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 98, 99], 

142 [1, 2, 5, 10, 11, 13, 14, 99], 

143 "1-2, 5-11, 13-14, 99", 

144 ), 

145 ( 

146 [1, 2, 3, 4, 98, 99, 100, 101, 102, 103, 104], 

147 [1, 2, 99, 102, 103, 104], 

148 "1-2, 99, 102-104", 

149 ), 

150 ([17], [17], "17"), 

151 ([90, 91, 92, 93, 94, 95], [90, 91, 92, 93, 94, 95], "90-95"), 

152 ([1, 2, 3, 4, 5], [], ""), 

153 ([1, 2, 3, 4, 5], [4], "4"), 

154 ], 

155) 

156def test_format_lines( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

157 statements: Iterable[TLineNo], 

158 lines: Iterable[TLineNo], 

159 result: str, 

160) -> None: 

161 assert format_lines(statements, lines) == result 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

162 

163 

164@pytest.mark.parametrize( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

165 "statements, lines, arcs, result", 

166 [ 

167 ( 

168 {1, 2, 3, 4, 5, 10, 11, 12, 13, 14}, 

169 {1, 2, 5, 10, 11, 13, 14}, 

170 (), 

171 "1-2, 5-11, 13-14", 

172 ), 

173 ( 

174 [1, 2, 3, 4, 5, 10, 11, 12, 13, 14, 98, 99], 

175 [1, 2, 5, 10, 11, 13, 14, 99], 

176 [(3, [4]), (5, [10, 11]), (98, [100, -1])], 

177 "1-2, 3->4, 5-11, 13-14, 98->100, 98->exit, 99", 

178 ), 

179 ( 

180 [1, 2, 3, 4, 98, 99, 100, 101, 102, 103, 104], 

181 [1, 2, 99, 102, 103, 104], 

182 [(3, [4]), (104, [-1])], 

183 "1-2, 3->4, 99, 102-104", 

184 ), 

185 ], 

186) 

187def test_format_lines_with_arcs( 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()

188 statements: Iterable[TLineNo], 

189 lines: Iterable[TLineNo], 

190 arcs: Iterable[tuple[TLineNo, list[TLineNo]]], 

191 result: str, 

192) -> None: 

193 assert format_lines(statements, lines, arcs) == result 69 ctx1abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!#$%'()