FilesExpand file tree

codeql-cli/v2.27.2

/

test_diagnostics.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

167 lines (132 loc) · 5.43 KB

codeql-cli/v2.27.2

/

test_diagnostics.py

Copy path

Top

File metadata and controls

• Code
• Blame

167 lines (132 loc) · 5.43 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import platform

from semmle import logging

from semmle import util

from semmle import worker

from semmle.python.modules import PythonSourceModule

def test_extractor_telemetry_message(mocker):

mocker.patch("semmle.logging.get_analysis_version", return_value="3.13")

message = logging.extractor_telemetry_message(["colorize", "p"]).to_dict()

message.pop("timestamp")

assert message == {

"source": {

"id": "py/extractor/summary",

"name": "Python extractor telemetry",

"extractorName": "python",

},

"severity": "note",

"markdownMessage": "Internal telemetry for the Python extractor.\n\nNo action needed.",

"visibility": {

"statusPage": False,

"cliSummaryTable": False,

"telemetry": True,

},

"attributes": {

"python_analysis_version": "3.13",

"python_runtime_version": platform.python_version(),

"extractor_version": util.VERSION,

"extractor_flags": "colorize p",

},

}

def test_parser_statistics_telemetry_message():

message = logging.parser_statistics_telemetry_message(

old_parser_file_count=12, tree_sitter_parser_file_count=3

).to_dict()

message.pop("timestamp")

assert message == {

"source": {

"id": "py/extractor/parser-statistics",

"name": "Python parser statistics",

"extractorName": "python",

},

"severity": "note",

"markdownMessage": "Internal parser telemetry for the Python extractor.\n\nNo action needed.",

"visibility": {

"statusPage": False,

"cliSummaryTable": False,

"telemetry": True,

},

"attributes": {

"old_parser_file_count": 12,

"tree_sitter_parser_file_count": 3,

},

}

def test_extractor_telemetry_message_includes_empty_flags():

message = logging.extractor_telemetry_message([]).to_dict()

assert message["attributes"]["extractor_flags"] == "default"

def test_write_extractor_telemetry(mocker):

diagnostics_writer = mocker.Mock()

logger = mocker.Mock()

worker._write_extractor_telemetry(diagnostics_writer, logger, ["quiet"])

diagnostics_writer.write.assert_called_once()

assert diagnostics_writer.write.call_args.args[0].to_dict()["attributes"] == {

"python_analysis_version": util.get_analysis_version(),

"python_runtime_version": platform.python_version(),

"extractor_version": util.VERSION,

"extractor_flags": "quiet",

}

logger.warning.assert_not_called()

def test_write_extractor_telemetry_handles_io_error(mocker):

diagnostics_writer = mocker.Mock()

diagnostics_writer.write.side_effect = OSError("write failed")

logger = mocker.Mock()

worker._write_extractor_telemetry(diagnostics_writer, logger, [])

logger.warning.assert_called_once_with(

"Failed to write extractor telemetry: %s", diagnostics_writer.write.side_effect

)

def test_write_parser_statistics_telemetry(mocker):

diagnostics_writer = mocker.Mock()

diagnostics_writer.parser_statistics.return_value = (1, 1)

logger = mocker.Mock()

worker._write_parser_statistics_telemetry(diagnostics_writer, logger)

diagnostics_writer.write.assert_called_once()

assert diagnostics_writer.write.call_args.args[0].to_dict()["attributes"] == {

"old_parser_file_count": 1,

"tree_sitter_parser_file_count": 1,

}

logger.warning.assert_not_called()

def test_does_not_write_empty_parser_statistics_telemetry(mocker):

diagnostics_writer = mocker.Mock()

diagnostics_writer.parser_statistics.return_value = (0, 0)

logger = mocker.Mock()

worker._write_parser_statistics_telemetry(diagnostics_writer, logger)

diagnostics_writer.write.assert_not_called()

logger.warning.assert_not_called()

def test_records_old_parser_usage_once(mocker, monkeypatch):

monkeypatch.delenv("CODEQL_PYTHON_DISABLE_OLD_PARSER", raising=False)

monkeypatch.delenv("CODEQL_PYTHON_DISABLE_TSG_PARSER", raising=False)

old_ast = object()

mocker.patch("semmle.python.parser.parse", return_value=old_ast)

diagnostics_writer = worker.DiagnosticsWriter(1)

module = PythonSourceModule(

None,

"test.py",

mocker.Mock(),

diagnostics_writer,

bytes_source=b"x = 1\n",

)

parsed_ast = module.py_ast

# Access the cached AST again to verify that it is not counted twice.

_ = module.py_ast

assert parsed_ast is old_ast

assert diagnostics_writer.parser_statistics() == (1, 0)

def test_records_tree_sitter_parser_usage_once(mocker, monkeypatch):

monkeypatch.delenv("CODEQL_PYTHON_DISABLE_OLD_PARSER", raising=False)

monkeypatch.delenv("CODEQL_PYTHON_DISABLE_TSG_PARSER", raising=False)

tree_sitter_ast = object()

mocker.patch("semmle.python.parser.parse", side_effect=SyntaxError("old parser failed"))

mocker.patch(

"semmle.python.parser.tsg_parser.parse", return_value=tree_sitter_ast

)

diagnostics_writer = worker.DiagnosticsWriter(1)

module = PythonSourceModule(

None,

"test.py",

mocker.Mock(),

diagnostics_writer,

bytes_source=b"x = 1\n",

)

parsed_ast = module.py_ast

# Access the cached AST again to verify that it is not counted twice.

_ = module.py_ast

assert parsed_ast is tree_sitter_ast

assert diagnostics_writer.parser_statistics() == (0, 1)