This repository was archived by the owner on Mar 17, 2026. It is now read-only.
forked from microsoft/vscode-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path__init__.py
More file actions
669 lines (562 loc) · 22.1 KB
/
Copy path__init__.py
File metadata and controls
669 lines (562 loc) · 22.1 KB
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
import json
import os
import pathlib
import sys
import traceback
import pytest
script_dir = pathlib.Path(__file__).parent.parent
sys.path.append(os.fspath(script_dir))
sys.path.append(os.fspath(script_dir / "lib" / "python"))
from typing import Any, Dict, List, Optional, Union
from testing_tools import socket_manager
from typing_extensions import Literal, TypedDict
class TestData(TypedDict):
"""A general class that all test objects inherit from."""
name: str
path: pathlib.Path
type_: Literal["class", "function", "file", "folder", "test", "error"]
id_: str
class TestItem(TestData):
"""A class defining test items."""
lineno: str
runID: str
class TestNode(TestData):
"""A general class that handles all test data which contains children."""
children: "list[Union[TestNode, TestItem, None]]"
class VSCodePytestError(Exception):
"""A custom exception class for pytest errors."""
def __init__(self, message):
super().__init__(message)
ERRORS = []
def pytest_internalerror(excrepr, excinfo):
"""A pytest hook that is called when an internal error occurs.
Keyword arguments:
excrepr -- the exception representation.
excinfo -- the exception information of type ExceptionInfo.
"""
# call.excinfo.exconly() returns the exception as a string.
ERRORS.append(excinfo.exconly() + "\n Check Python Test Logs for more details.")
def pytest_exception_interact(node, call, report):
"""A pytest hook that is called when an exception is raised which could be handled.
Keyword arguments:
node -- the node that raised the exception.
call -- the call object.
report -- the report object of either type CollectReport or TestReport.
"""
# call.excinfo is the captured exception of the call, if it raised as type ExceptionInfo.
# call.excinfo.exconly() returns the exception as a string.
# See if it is during discovery or execution.
# if discovery, then add the error to error logs.
if type(report) == pytest.CollectReport:
if call.excinfo and call.excinfo.typename != "AssertionError":
if report.outcome == "skipped" and "SkipTest" in str(call):
return
ERRORS.append(
call.excinfo.exconly() + "\n Check Python Test Logs for more details."
)
else:
ERRORS.append(
report.longreprtext + "\n Check Python Test Logs for more details."
)
else:
# if execution, send this data that the given node failed.
report_value = "error"
if call.excinfo.typename == "AssertionError":
report_value = "failure"
node_id = str(node.nodeid)
if node_id not in collected_tests_so_far:
collected_tests_so_far.append(node_id)
item_result = create_test_outcome(
node_id,
report_value,
"Test failed with exception",
report.longreprtext,
)
collected_test = testRunResultDict()
collected_test[node_id] = item_result
cwd = pathlib.Path.cwd()
execution_post(
os.fsdecode(cwd),
"success",
collected_test if collected_test else None,
)
def pytest_keyboard_interrupt(excinfo):
"""A pytest hook that is called when a keyboard interrupt is raised.
Keyword arguments:
excinfo -- the exception information of type ExceptionInfo.
"""
# The function execonly() returns the exception as a string.
ERRORS.append(excinfo.exconly() + "\n Check Python Test Logs for more details.")
class TestOutcome(Dict):
"""A class that handles outcome for a single test.
for pytest the outcome for a test is only 'passed', 'skipped' or 'failed'
"""
test: str
outcome: Literal["success", "failure", "skipped", "error"]
message: Union[str, None]
traceback: Union[str, None]
subtest: Optional[str]
def create_test_outcome(
test: str,
outcome: str,
message: Union[str, None],
traceback: Union[str, None],
subtype: Optional[str] = None,
) -> TestOutcome:
"""A function that creates a TestOutcome object."""
return TestOutcome(
test=test,
outcome=outcome,
message=message,
traceback=traceback, # TODO: traceback
subtest=None,
)
class testRunResultDict(Dict[str, Dict[str, TestOutcome]]):
"""A class that stores all test run results."""
outcome: str
tests: Dict[str, TestOutcome]
IS_DISCOVERY = False
def pytest_load_initial_conftests(early_config, parser, args):
if "--collect-only" in args:
global IS_DISCOVERY
IS_DISCOVERY = True
collected_tests_so_far = list()
def pytest_report_teststatus(report, config):
"""
A pytest hook that is called when a test is called. It is called 3 times per test,
during setup, call, and teardown.
Keyword arguments:
report -- the report on the test setup, call, and teardown.
config -- configuration object.
"""
cwd = pathlib.Path.cwd()
if report.when == "call":
traceback = None
message = None
report_value = "skipped"
if report.passed:
report_value = "success"
elif report.failed:
report_value = "failure"
message = report.longreprtext
node_id = str(report.nodeid)
if node_id not in collected_tests_so_far:
collected_tests_so_far.append(node_id)
item_result = create_test_outcome(
node_id,
report_value,
message,
traceback,
)
collected_test = testRunResultDict()
collected_test[node_id] = item_result
execution_post(
os.fsdecode(cwd),
"success",
collected_test if collected_test else None,
)
ERROR_MESSAGE_CONST = {
2: "Pytest was unable to start or run any tests due to issues with test discovery or test collection.",
3: "Pytest was interrupted by the user, for example by pressing Ctrl+C during test execution.",
4: "Pytest encountered an internal error or exception during test execution.",
5: "Pytest was unable to find any tests to run.",
}
def pytest_runtest_protocol(item, nextitem):
skipped = check_skipped_wrapper(item)
if skipped:
node_id = str(item.nodeid)
report_value = "skipped"
cwd = pathlib.Path.cwd()
if node_id not in collected_tests_so_far:
collected_tests_so_far.append(node_id)
item_result = create_test_outcome(
node_id,
report_value,
None,
None,
)
collected_test = testRunResultDict()
collected_test[node_id] = item_result
execution_post(
os.fsdecode(cwd),
"success",
collected_test if collected_test else None,
)
def check_skipped_wrapper(item):
"""A function that checks if a test is skipped or not by check its markers and its parent markers.
Returns True if the test is marked as skipped at any level, False otherwise.
Keyword arguments:
item -- the pytest item object.
"""
if item.own_markers:
if check_skipped_condition(item):
return True
parent = item.parent
while isinstance(parent, pytest.Class):
if parent.own_markers:
if check_skipped_condition(parent):
return True
parent = parent.parent
return False
def check_skipped_condition(item):
"""A helper function that checks if a item has a skip or a true skip condition.
Keyword arguments:
item -- the pytest item object.
"""
for marker in item.own_markers:
# If the test is marked with skip then it will not hit the pytest_report_teststatus hook,
# therefore we need to handle it as skipped here.
skip_condition = False
if marker.name == "skipif":
skip_condition = any(marker.args)
if marker.name == "skip" or skip_condition:
return True
return False
def pytest_sessionfinish(session, exitstatus):
"""A pytest hook that is called after pytest has fulled finished.
Keyword arguments:
session -- the pytest session object.
exitstatus -- the status code of the session.
0: All tests passed successfully.
1: One or more tests failed.
2: Pytest was unable to start or run any tests due to issues with test discovery or test collection.
3: Pytest was interrupted by the user, for example by pressing Ctrl+C during test execution.
4: Pytest encountered an internal error or exception during test execution.
5: Pytest was unable to find any tests to run.
"""
print(
"pytest session has finished, exit status: ",
exitstatus,
"in discovery? ",
IS_DISCOVERY,
)
cwd = pathlib.Path.cwd()
if IS_DISCOVERY:
if not (exitstatus == 0 or exitstatus == 1 or exitstatus == 5):
errorNode: TestNode = {
"name": "",
"path": cwd,
"type_": "error",
"children": [],
"id_": "",
}
post_response(os.fsdecode(cwd), errorNode)
try:
session_node: Union[TestNode, None] = build_test_tree(session)
if not session_node:
raise VSCodePytestError(
"Something went wrong following pytest finish, \
no session node was created"
)
post_response(os.fsdecode(cwd), session_node)
except Exception as e:
ERRORS.append(
f"Error Occurred, traceback: {(traceback.format_exc() if e.__traceback__ else '')}"
)
errorNode: TestNode = {
"name": "",
"path": cwd,
"type_": "error",
"children": [],
"id_": "",
}
post_response(os.fsdecode(cwd), errorNode)
else:
if exitstatus == 0 or exitstatus == 1:
exitstatus_bool = "success"
else:
ERRORS.append(
f"Pytest exited with error status: {exitstatus}, {ERROR_MESSAGE_CONST[exitstatus]}"
)
exitstatus_bool = "error"
execution_post(
os.fsdecode(cwd),
exitstatus_bool,
None,
)
def build_test_tree(session: pytest.Session) -> TestNode:
"""Builds a tree made up of testing nodes from the pytest session.
Keyword arguments:
session -- the pytest session object.
"""
session_node = create_session_node(session)
session_children_dict: Dict[str, TestNode] = {}
file_nodes_dict: Dict[Any, TestNode] = {}
class_nodes_dict: Dict[str, TestNode] = {}
function_nodes_dict: Dict[str, TestNode] = {}
for test_case in session.items:
test_node = create_test_node(test_case)
if isinstance(test_case.parent, pytest.Class):
try:
test_class_node = class_nodes_dict[test_case.parent.nodeid]
except KeyError:
test_class_node = create_class_node(test_case.parent)
class_nodes_dict[test_case.parent.nodeid] = test_class_node
test_class_node["children"].append(test_node)
if test_case.parent.parent:
parent_module = test_case.parent.parent
else:
ERRORS.append(f"Test class {test_case.parent} has no parent")
break
# Create a file node that has the class as a child.
try:
test_file_node: TestNode = file_nodes_dict[parent_module]
except KeyError:
test_file_node = create_file_node(parent_module)
file_nodes_dict[parent_module] = test_file_node
# Check if the class is already a child of the file node.
if test_class_node not in test_file_node["children"]:
test_file_node["children"].append(test_class_node)
elif hasattr(test_case, "callspec"): # This means it is a parameterized test.
function_name: str = ""
# parameterized test cases cut the repetitive part of the name off.
name_split = test_node["name"].split("[")
test_node["name"] = "[" + name_split[1]
parent_path = os.fspath(get_node_path(test_case)) + "::" + name_split[0]
try:
function_name = test_case.originalname # type: ignore
function_test_case = function_nodes_dict[parent_path]
except AttributeError: # actual error has occurred
ERRORS.append(
f"unable to find original name for {test_case.name} with parameterization detected."
)
raise VSCodePytestError(
"Unable to find original name for parameterized test case"
)
except KeyError:
function_test_case: TestNode = create_parameterized_function_node(
function_name, get_node_path(test_case), test_case.nodeid
)
function_nodes_dict[parent_path] = function_test_case
function_test_case["children"].append(test_node)
# Now, add the function node to file node.
try:
parent_test_case = file_nodes_dict[test_case.parent]
except KeyError:
parent_test_case = create_file_node(test_case.parent)
file_nodes_dict[test_case.parent] = parent_test_case
if function_test_case not in parent_test_case["children"]:
parent_test_case["children"].append(function_test_case)
else: # This includes test cases that are pytest functions or a doctests.
try:
parent_test_case = file_nodes_dict[test_case.parent]
except KeyError:
parent_test_case = create_file_node(test_case.parent)
file_nodes_dict[test_case.parent] = parent_test_case
parent_test_case["children"].append(test_node)
created_files_folders_dict: Dict[str, TestNode] = {}
for _, file_node in file_nodes_dict.items():
# Iterate through all the files that exist and construct them into nested folders.
root_folder_node: TestNode = build_nested_folders(
file_node, created_files_folders_dict, session
)
# The final folder we get to is the highest folder in the path
# and therefore we add this as a child to the session.
root_id = root_folder_node.get("id_")
if root_id and root_id not in session_children_dict:
session_children_dict[root_id] = root_folder_node
session_node["children"] = list(session_children_dict.values())
return session_node
def build_nested_folders(
file_node: TestNode,
created_files_folders_dict: Dict[str, TestNode],
session: pytest.Session,
) -> TestNode:
"""Takes a file or folder and builds the nested folder structure for it.
Keyword arguments:
file_module -- the created module for the file we are nesting.
file_node -- the file node that we are building the nested folders for.
created_files_folders_dict -- Dictionary of all the folders and files that have been created where the key is the path.
session -- the pytest session object.
"""
prev_folder_node = file_node
# Begin the iterator_path one level above the current file.
iterator_path = file_node["path"].parent
while iterator_path != get_node_path(session):
curr_folder_name = iterator_path.name
try:
curr_folder_node: TestNode = created_files_folders_dict[
os.fspath(iterator_path)
]
except KeyError:
curr_folder_node: TestNode = create_folder_node(
curr_folder_name, iterator_path
)
created_files_folders_dict[os.fspath(iterator_path)] = curr_folder_node
if prev_folder_node not in curr_folder_node["children"]:
curr_folder_node["children"].append(prev_folder_node)
iterator_path = iterator_path.parent
prev_folder_node = curr_folder_node
return prev_folder_node
def create_test_node(
test_case: pytest.Item,
) -> TestItem:
"""Creates a test node from a pytest test case.
Keyword arguments:
test_case -- the pytest test case.
"""
test_case_loc: str = (
str(test_case.location[1] + 1) if (test_case.location[1] is not None) else ""
)
return {
"name": test_case.name,
"path": get_node_path(test_case),
"lineno": test_case_loc,
"type_": "test",
"id_": test_case.nodeid,
"runID": test_case.nodeid,
}
def create_session_node(session: pytest.Session) -> TestNode:
"""Creates a session node from a pytest session.
Keyword arguments:
session -- the pytest session.
"""
node_path = get_node_path(session)
return {
"name": session.name,
"path": node_path,
"type_": "folder",
"children": [],
"id_": os.fspath(node_path),
}
def create_class_node(class_module: pytest.Class) -> TestNode:
"""Creates a class node from a pytest class object.
Keyword arguments:
class_module -- the pytest object representing a class module.
"""
return {
"name": class_module.name,
"path": get_node_path(class_module),
"type_": "class",
"children": [],
"id_": class_module.nodeid,
}
def create_parameterized_function_node(
function_name: str, test_path: pathlib.Path, test_id: str
) -> TestNode:
"""Creates a function node to be the parent for the parameterized test nodes.
Keyword arguments:
function_name -- the name of the function.
test_path -- the path to the test file.
test_id -- the id of the test, which is a parameterized test so it
must be edited to get a unique id for the function node.
"""
function_id: str = test_id.split("::")[0] + "::" + function_name
return {
"name": function_name,
"path": test_path,
"type_": "function",
"children": [],
"id_": function_id,
}
def create_file_node(file_module: Any) -> TestNode:
"""Creates a file node from a pytest file module.
Keyword arguments:
file_module -- the pytest file module.
"""
node_path = get_node_path(file_module)
return {
"name": node_path.name,
"path": node_path,
"type_": "file",
"id_": os.fspath(node_path),
"children": [],
}
def create_folder_node(folder_name: str, path_iterator: pathlib.Path) -> TestNode:
"""Creates a folder node from a pytest folder name and its path.
Keyword arguments:
folderName -- the name of the folder.
path_iterator -- the path of the folder.
"""
return {
"name": folder_name,
"path": path_iterator,
"type_": "folder",
"id_": os.fspath(path_iterator),
"children": [],
}
class DiscoveryPayloadDict(TypedDict):
"""A dictionary that is used to send a post request to the server."""
cwd: str
status: Literal["success", "error"]
tests: Optional[TestNode]
error: Optional[List[str]]
class ExecutionPayloadDict(Dict):
"""
A dictionary that is used to send a execution post request to the server.
"""
cwd: str
status: Literal["success", "error"]
result: Union[testRunResultDict, None]
not_found: Union[List[str], None] # Currently unused need to check
error: Union[str, None] # Currently unused need to check
def get_node_path(node: Any) -> pathlib.Path:
return getattr(node, "path", pathlib.Path(node.fspath))
def execution_post(
cwd: str,
status: Literal["success", "error"],
tests: Union[testRunResultDict, None],
):
"""
Sends a post request to the server after the tests have been executed.
Keyword arguments:
cwd -- the current working directory.
session_node -- the status of running the tests
tests -- the tests that were run and their status.
"""
testPort = os.getenv("TEST_PORT", 45454)
testuuid = os.getenv("TEST_UUID")
payload: ExecutionPayloadDict = ExecutionPayloadDict(
cwd=cwd, status=status, result=tests, not_found=None, error=None
)
if ERRORS:
payload["error"] = ERRORS
addr = ("localhost", int(testPort))
data = json.dumps(payload)
request = f"""Content-Length: {len(data)}
Content-Type: application/json
Request-uuid: {testuuid}
{data}"""
try:
with socket_manager.SocketManager(addr) as s:
if s.socket is not None:
s.socket.sendall(request.encode("utf-8"))
except Exception as e:
print(f"Plugin error connection error[vscode-pytest]: {e}")
print(f"[vscode-pytest] data: {request}")
class PathEncoder(json.JSONEncoder):
"""A custom JSON encoder that encodes pathlib.Path objects as strings."""
def default(self, obj):
if isinstance(obj, pathlib.Path):
return os.fspath(obj)
return super().default(obj)
def post_response(cwd: str, session_node: TestNode) -> None:
"""Sends a post request to the server.
Keyword arguments:
cwd -- the current working directory.
session_node -- the session node, which is the top of the testing tree.
errors -- a list of errors that occurred during test collection.
"""
payload: DiscoveryPayloadDict = {
"cwd": cwd,
"status": "success" if not ERRORS else "error",
"tests": session_node,
"error": [],
}
if ERRORS is not None:
payload["error"] = ERRORS
test_port: Union[str, int] = os.getenv("TEST_PORT", 45454)
test_uuid: Union[str, None] = os.getenv("TEST_UUID")
addr = "localhost", int(test_port)
data = json.dumps(payload, cls=PathEncoder)
request = f"""Content-Length: {len(data)}
Content-Type: application/json
Request-uuid: {test_uuid}
{data}"""
try:
with socket_manager.SocketManager(addr) as s:
if s.socket is not None:
s.socket.sendall(request.encode("utf-8"))
except Exception as e:
print(f"Plugin error connection error[vscode-pytest]: {e}")
print(f"[vscode-pytest] data: {request}")