21552830208

Committed 31 Jan 2026 11:40PM UTC coverage: 80.277% (-0.05%) from 80.324%

Build # 21552830208

Build Type

Pull #23062

github

Committed by

web-flow

Commit Message

Merge 808a9786c into 2c4dcf9cf

Pull Request Pull Request #23062: Remove support for Get

Run Details

18 of 25 new or added lines in 4 files covered. (72.0%)

17119 existing lines in 541 files now uncovered.

78278 of 97510 relevant lines covered (80.28%)

3.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

54.67

/src/python/pants/bsp/spec/task.py

1	# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
UNCOV 3	from __future__ import annotations	2✔
4
UNCOV 5	from dataclasses import dataclass	2✔
UNCOV 6	from enum import Enum	2✔
UNCOV 7	from typing import Any	2✔
8
UNCOV 9	from pants.bsp.spec.base import StatusCode, TaskId	2✔
UNCOV 10	from pants.bsp.spec.compile import CompileReport, CompileTask	2✔
UNCOV 11	from pants.bsp.spec.notification import BSPNotification	2✔
12
13	# -----------------------------------------------------------------------------------------------
14	# Task Notifications
15	# See https://build-server-protocol.github.io/docs/specification.html#compile-request
16	# -----------------------------------------------------------------------------------------------
17
18
UNCOV 19	class TaskDataKind(Enum):	2✔
20	# `data` field must contain a CompileTask object.
UNCOV 21	COMPILE_TASK = "compile-task"	2✔
22
23	# `data` field must contain a CompileReport object.
UNCOV 24	COMPILE_REPORT = "compile-report"	2✔
25
26	# `data` field must contain a TestTask object.
UNCOV 27	TEST_TASK = "test-task"	2✔
28
29	# `data` field must contain a TestReport object.
UNCOV 30	TEST_REPORT = "test-report"	2✔
31
32	# `data` field must contain a TestStart object.
UNCOV 33	TEST_START = "test-start"	2✔
34
35	# `data` field must contain a TestFinish object.
UNCOV 36	TEST_FINISH = "test-finish"	2✔
37
38
UNCOV 39	@dataclass(frozen=True)	2✔
UNCOV 40	class TaskStartParams(BSPNotification):	2✔
UNCOV 41	notification_name = "build/taskStart"	2✔
42
43	# Unique id of the task with optional reference to parent task id
UNCOV 44	task_id: TaskId	2✔
45
46	# Timestamp of when the event started in milliseconds since Epoch.
UNCOV 47	event_time: int \| None = None	2✔
48
49	# Message describing the task.
UNCOV 50	message: str \| None = None	2✔
51
52	# Task-specific data.
53	# Note: This field is serialized as two fields: `dataKind` (for type name) and `data`.
UNCOV 54	data: CompileTask \| None = None	2✔
55
UNCOV 56	def to_json_dict(self) -> dict[str, Any]:	2✔
57	result: dict[str, Any] = {"taskId": self.task_id.to_json_dict()}	×
58	if self.event_time is not None:	×
59	result["eventTime"] = self.event_time	×
60	if self.message is not None:	×
61	result["message"] = self.message	×
62	if self.data is not None:	×
63	if isinstance(self.data, CompileTask):	×
64	result["dataKind"] = TaskDataKind.COMPILE_TASK.value	×
65	else:
66	raise AssertionError(	×
67	f"TaskStartParams contained an unexpected instance: {self.data}"
68	)
69	result["data"] = self.data.to_json_dict()	×
70	return result	×
71
72
UNCOV 73	@dataclass(frozen=True)	2✔
UNCOV 74	class TaskProgressParams(BSPNotification):	2✔
UNCOV 75	notification_name = "build/taskProgress"	2✔
76
77	# Unique id of the task with optional reference to parent task id
UNCOV 78	task_id: TaskId	2✔
79
80	# Timestamp of when the progress event was generated in milliseconds since Epoch.
UNCOV 81	event_time: int \| None = None	2✔
82
83	# Message describing the task progress.
84	# Information about the state of the task at the time the event is sent.
UNCOV 85	message: str \| None = None	2✔
86
87	# If known, total amount of work units in this task.
UNCOV 88	total: int \| None = None	2✔
89
90	# If known, completed amount of work units in this task.
UNCOV 91	progress: int \| None = None	2✔
92
93	# Name of a work unit. For example, "files" or "tests". May be empty.
UNCOV 94	unit: str \| None = None	2✔
95
96	# TODO: `data` field is not currently represented. Once we know what types will be sent, then it can be bound.
97
UNCOV 98	def to_json_dict(self) -> dict[str, Any]:	2✔
99	result: dict[str, Any] = {"taskId": self.task_id.to_json_dict()}	×
100	if self.event_time is not None:	×
101	result["eventTime"] = self.event_time	×
102	if self.message is not None:	×
103	result["message"] = self.message	×
104	if self.total is not None:	×
105	result["total"] = self.total	×
106	if self.progress is not None:	×
107	result["progress"] = self.progress	×
108	if self.unit is not None:	×
109	result["unit"] = self.unit	×
110	return result	×
111
112
UNCOV 113	@dataclass(frozen=True)	2✔
UNCOV 114	class TaskFinishParams(BSPNotification):	2✔
UNCOV 115	notification_name = "build/taskFinish"	2✔
116
117	# Unique id of the task with optional reference to parent task id
UNCOV 118	task_id: TaskId	2✔
119
120	# Timestamp of the event in milliseconds.
UNCOV 121	event_time: int \| None = None	2✔
122
123	# Message describing the finish event.
UNCOV 124	message: str \| None = None	2✔
125
126	# Task completion status.
UNCOV 127	status: StatusCode = StatusCode.OK	2✔
128
129	# Task-specific data.
130	# Note: This field is serialized as two fields: `dataKind` (for type name) and `data`.
UNCOV 131	data: CompileReport \| None = None	2✔
132
UNCOV 133	def to_json_dict(self) -> dict[str, Any]:	2✔
134	result: dict[str, Any] = {	×
135	"taskId": self.task_id.to_json_dict(),
136	"status": self.status.value,
137	}
138	if self.event_time is not None:	×
139	result["eventTime"] = self.event_time	×
140	if self.message is not None:	×
141	result["message"] = self.message	×
142	if self.data is not None:	×
143	if isinstance(self.data, CompileReport):	×
144	result["dataKind"] = TaskDataKind.COMPILE_REPORT.value	×
145	else:
146	raise AssertionError(	×
147	f"TaskFinishParams contained an unexpected instance: {self.data}"
148	)
149	result["data"] = self.data.to_json_dict()	×
150	return result	×

pantsbuild / pants / 21552830208

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous