-
Notifications
You must be signed in to change notification settings - Fork 108
Expand file tree
/
Copy pathtest_connector_status.py
More file actions
293 lines (243 loc) · 10.5 KB
/
test_connector_status.py
File metadata and controls
293 lines (243 loc) · 10.5 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
import json
import os
import uuid
from datetime import datetime
from typing import Any
from confluent_kafka import Producer
from confluent_kafka.admin import AdminClient, NewTopic
from feldera import Pipeline, PipelineBuilder
from feldera.stats import InputEndpointStatus, OutputEndpointStatus
from tests import TEST_CLIENT
from tests.platform.helper import gen_pipeline_name, wait_for_condition
def env(name: str, default: str) -> str:
"""Get environment variables for the Kafka broker and Schema registry.
The default values are only meant for internal development; external users must set them."""
return os.getenv(name, default)
# Set these before running the test:
# Example(terminal/shell):
# export KAFKA_BOOTSTRAP=localhost:19092
KAFKA_BOOTSTRAP = env("KAFKA_BOOTSTRAP_SERVERS", "ci-kafka-bootstrap.kafka:9092")
def _random_topic(prefix: str) -> str:
return f"{prefix}-{uuid.uuid4().hex[:12]}"
def _kafka_clients() -> tuple[Any, Any, Any]:
return Producer, AdminClient, NewTopic
def _create_topic(
admin: Any, topic: str, new_topic_cls: Any, timeout_s: float = 30.0
) -> None:
futures = admin.create_topics(
[new_topic_cls(topic=topic, num_partitions=1, replication_factor=1)]
)
futures[topic].result(timeout=timeout_s)
def _delete_topic_best_effort(admin: Any, topic: str) -> None:
try:
futures = admin.delete_topics([topic], operation_timeout=10)
futures[topic].result(timeout=10)
except Exception:
# Topic deletion can be disabled on some brokers; cleanup is best-effort.
pass
def _produce_records(topic: str, values: list[str]) -> None:
producer_cls, _, _ = _kafka_clients()
producer = producer_cls({"bootstrap.servers": KAFKA_BOOTSTRAP})
for value in values:
producer.produce(topic, value=value.encode("utf-8"))
remaining = producer.flush(timeout=30)
if remaining != 0:
raise RuntimeError(f"Failed to flush all Kafka messages, remaining={remaining}")
def _assert_connector_error_list(errors: Any) -> None:
if errors is None:
return
assert isinstance(errors, list)
for error in errors:
assert isinstance(error.timestamp, datetime)
assert isinstance(error.index, int)
assert isinstance(error.message, str)
assert error.tag is None or isinstance(error.tag, str)
def _assert_input_status_fields(status, expected_stream: str) -> None:
# Top-level fields
assert isinstance(status.endpoint_name, str)
assert status.endpoint_name
assert isinstance(status.fatal_error, str) or status.fatal_error is None
assert isinstance(status.paused, bool)
assert isinstance(status.barrier, bool)
# Metrics
metrics = status.metrics
assert isinstance(metrics.total_bytes, int)
assert isinstance(metrics.total_records, int)
assert isinstance(metrics.buffered_records, int)
assert isinstance(metrics.buffered_bytes, int)
assert isinstance(metrics.num_transport_errors, int)
assert isinstance(metrics.num_parse_errors, int)
assert isinstance(metrics.end_of_input, bool)
# Optional rich fields
_assert_connector_error_list(status.parse_errors)
_assert_connector_error_list(status.transport_errors)
if status.completed_frontier is not None:
assert isinstance(status.completed_frontier.metadata, object)
assert isinstance(status.completed_frontier.ingested_at, datetime)
assert isinstance(status.completed_frontier.processed_at, datetime)
assert isinstance(status.completed_frontier.completed_at, datetime)
def _assert_output_status_fields(status, expected_stream: str) -> None:
# Top-level fields
assert isinstance(status.endpoint_name, str)
assert status.endpoint_name
assert isinstance(status.fatal_error, str) or status.fatal_error is None
# Metrics
metrics = status.metrics
assert isinstance(metrics.transmitted_records, int)
assert isinstance(metrics.transmitted_bytes, int)
assert isinstance(metrics.queued_records, int)
assert isinstance(metrics.queued_batches, int)
assert isinstance(metrics.buffered_records, int)
assert isinstance(metrics.buffered_batches, int)
assert isinstance(metrics.num_encode_errors, int)
assert isinstance(metrics.num_transport_errors, int)
assert isinstance(metrics.total_processed_input_records, int)
assert isinstance(metrics.total_processed_steps, int)
assert isinstance(metrics.memory, int)
# Optional rich fields
_assert_connector_error_list(status.encode_errors)
_assert_connector_error_list(status.transport_errors)
def _status_to_primitive(value: Any) -> Any:
if isinstance(value, datetime):
return value.isoformat()
if isinstance(value, list):
return [_status_to_primitive(item) for item in value]
if isinstance(value, dict):
return {k: _status_to_primitive(v) for k, v in value.items()}
if hasattr(value, "__dict__"):
return {
key: _status_to_primitive(val)
for key, val in value.__dict__.items()
if not key.startswith("_")
}
return value
@gen_pipeline_name
def test_connector_status(pipeline_name):
"""
Test connector status, and especially error reporting.
Create a pipeline with one input and one output Kafka connector. Feed some valid and invalid
JSON records to the input connector. Invalid records are dropped and reported as parse errors,
valid records are passed to the output connector. The output connector is configured with an
incorrect Avro schema, so it fails to send all 500 records.
Both connectors should report error count of 500 errors, but should only list 100 errors in
the error lists, since we truncate the error lists to 100 errors of each type.
The test validates connector statuses returned by both connectors and in particular checks
error counts and error lists.
"""
_, admin_cls, new_topic_cls = _kafka_clients()
admin = admin_cls({"bootstrap.servers": KAFKA_BOOTSTRAP})
input_topic = _random_topic("connector-errors-input")
output_topic = _random_topic("connector-errors-output")
_create_topic(admin, input_topic, new_topic_cls)
_create_topic(admin, output_topic, new_topic_cls)
wrong_avro_schema = {
"type": "record",
"name": "WrongOutputSchema",
"fields": [{"name": "c1", "type": "string"}],
}
input_connector = {
"name": "kafka_in",
# Make sure the input connector processes records one by one.
"max_batch_size": 1,
"transport": {
"name": "kafka_input",
"config": {
"topic": input_topic,
"bootstrap.servers": KAFKA_BOOTSTRAP,
"start_from": "earliest",
},
},
"format": {
"name": "json",
"config": {"update_format": "raw", "array": False},
},
}
output_connector = {
"name": "kafka_out",
"transport": {
"name": "kafka_output",
"config": {"topic": output_topic, "bootstrap.servers": KAFKA_BOOTSTRAP},
},
"format": {
"name": "avro",
"config": {"update_format": "raw", "schema": json.dumps(wrong_avro_schema)},
},
}
sql = f"""
CREATE TABLE input_t(c1 INT) WITH (
'connectors' = '{json.dumps([input_connector])}'
);
CREATE MATERIALIZED VIEW output_v WITH (
'connectors' = '{json.dumps([output_connector])}'
) AS SELECT * FROM input_t;
""".strip()
pipeline: Pipeline = PipelineBuilder(
TEST_CLIENT,
name=pipeline_name,
sql=sql,
).create_or_replace()
pipeline.start()
def input_connector_status() -> InputEndpointStatus:
status = pipeline.input_connector_stats(
table_name="input_t", connector_name="kafka_in"
)
_assert_input_status_fields(status, expected_stream="input_t")
return status
def output_connector_status() -> OutputEndpointStatus:
status = pipeline.output_connector_stats(
view_name="output_v", connector_name="kafka_out"
)
_assert_output_status_fields(status, expected_stream="output_v")
return status
try:
valid_records = [json.dumps({"c1": i}) for i in range(500)]
_produce_records(input_topic, valid_records)
wait_for_condition(
"output connector encode error count reaches 500",
lambda: output_connector_status().metrics.num_encode_errors == 500
and len(output_connector_status().encode_errors) == 100,
timeout_s=100.0,
poll_interval_s=1.0,
)
input_status = input_connector_status()
output_status = output_connector_status()
print(
f"input_status: {json.dumps(_status_to_primitive(input_status), indent=2)}"
)
print(
f"output_status: {json.dumps(_status_to_primitive(output_status), indent=2)}"
)
assert input_status.parse_errors is not None
assert output_status.encode_errors is not None
assert len(input_status.parse_errors) == 0
assert len(output_status.encode_errors) == 100
assert output_status.metrics.num_encode_errors == 500
assert input_status.metrics.num_parse_errors == 0
invalid_records = ["invalid\n"] * 500
_produce_records(input_topic, invalid_records)
wait_for_condition(
"input connector parse error count reaches 500",
lambda: input_connector_status().metrics.num_parse_errors == 500
and len(input_connector_status().parse_errors) == 100,
timeout_s=100.0,
poll_interval_s=1.0,
)
input_status = input_connector_status()
output_status = output_connector_status()
assert input_status.parse_errors is not None
assert len(input_status.parse_errors) == 100
assert input_status.metrics.num_parse_errors == 500
assert input_status.metrics.num_transport_errors == 0
assert not input_status.metrics.end_of_input
assert input_status.fatal_error is None
assert input_status.metrics.total_records == 500
assert input_status.health is None
assert output_status.encode_errors is not None
assert len(output_status.encode_errors) == 100
assert output_status.metrics.num_encode_errors == 500
assert output_status.metrics.num_transport_errors == 0
assert output_status.fatal_error is None
assert output_status.health is None
finally:
_delete_topic_best_effort(admin, input_topic)
_delete_topic_best_effort(admin, output_topic)