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
|
"""
Specific tests to validate the "related events" logic used by certain events
inside hyper-h2.
"""
from __future__ import annotations
import pytest
import h2.config
import h2.connection
import h2.events
class TestRelatedEvents:
"""
Related events correlate all those events that happen on a single frame.
"""
example_request_headers = [
(":authority", "example.com"),
(":path", "/"),
(":scheme", "https"),
(":method", "GET"),
]
example_request_headers_bytes = [
(b":authority", b"example.com"),
(b":path", b"/"),
(b":scheme", b"https"),
(b":method", b"GET"),
]
example_response_headers = [
(":status", "200"),
("server", "fake-serv/0.1.0"),
]
informational_response_headers = [
(":status", "100"),
("server", "fake-serv/0.1.0"),
]
example_trailers = [
("another", "field"),
]
server_config = h2.config.H2Configuration(client_side=False)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_request_received_related_all(self, frame_factory, request_headers) -> None:
"""
RequestReceived has two possible related events: PriorityUpdated and
StreamEnded, all fired when a single HEADERS frame is received.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
input_frame = frame_factory.build_headers_frame(
headers=request_headers,
flags=["END_STREAM", "PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 3
base_event = events[0]
other_events = events[1:]
assert base_event.stream_ended in other_events
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
assert base_event.priority_updated in other_events
assert isinstance(
base_event.priority_updated, h2.events.PriorityUpdated,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_request_received_related_priority(self, frame_factory, request_headers) -> None:
"""
RequestReceived can be related to PriorityUpdated.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
input_frame = frame_factory.build_headers_frame(
headers=request_headers,
flags=["PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
priority_updated_event = events[1]
assert base_event.priority_updated is priority_updated_event
assert base_event.stream_ended is None
assert isinstance(
base_event.priority_updated, h2.events.PriorityUpdated,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_request_received_related_stream_ended(self, frame_factory, request_headers) -> None:
"""
RequestReceived can be related to StreamEnded.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
input_frame = frame_factory.build_headers_frame(
headers=request_headers,
flags=["END_STREAM"],
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
stream_ended_event = events[1]
assert base_event.stream_ended is stream_ended_event
assert base_event.priority_updated is None
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_response_received_related_nothing(self, frame_factory, request_headers) -> None:
"""
ResponseReceived is ordinarily related to no events.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
input_frame = frame_factory.build_headers_frame(
headers=self.example_response_headers,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 1
base_event = events[0]
assert base_event.stream_ended is None
assert base_event.priority_updated is None
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_response_received_related_all(self, frame_factory, request_headers) -> None:
"""
ResponseReceived has two possible related events: PriorityUpdated and
StreamEnded, all fired when a single HEADERS frame is received.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
input_frame = frame_factory.build_headers_frame(
headers=self.example_response_headers,
flags=["END_STREAM", "PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 3
base_event = events[0]
other_events = events[1:]
assert base_event.stream_ended in other_events
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
assert base_event.priority_updated in other_events
assert isinstance(
base_event.priority_updated, h2.events.PriorityUpdated,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_response_received_related_priority(self, frame_factory, request_headers) -> None:
"""
ResponseReceived can be related to PriorityUpdated.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
input_frame = frame_factory.build_headers_frame(
headers=self.example_response_headers,
flags=["PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
priority_updated_event = events[1]
assert base_event.priority_updated is priority_updated_event
assert base_event.stream_ended is None
assert isinstance(
base_event.priority_updated, h2.events.PriorityUpdated,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_response_received_related_stream_ended(self, frame_factory, request_headers) -> None:
"""
ResponseReceived can be related to StreamEnded.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
input_frame = frame_factory.build_headers_frame(
headers=self.example_response_headers,
flags=["END_STREAM"],
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
stream_ended_event = events[1]
assert base_event.stream_ended is stream_ended_event
assert base_event.priority_updated is None
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_trailers_received_related_all(self, frame_factory, request_headers) -> None:
"""
TrailersReceived has two possible related events: PriorityUpdated and
StreamEnded, all fired when a single HEADERS frame is received.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
f = frame_factory.build_headers_frame(
headers=self.example_response_headers,
)
c.receive_data(f.serialize())
input_frame = frame_factory.build_headers_frame(
headers=self.example_trailers,
flags=["END_STREAM", "PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 3
base_event = events[0]
other_events = events[1:]
assert base_event.stream_ended in other_events
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
assert base_event.priority_updated in other_events
assert isinstance(
base_event.priority_updated, h2.events.PriorityUpdated,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_trailers_received_related_stream_ended(self, frame_factory, request_headers) -> None:
"""
TrailersReceived can be related to StreamEnded by itself.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
f = frame_factory.build_headers_frame(
headers=self.example_response_headers,
)
c.receive_data(f.serialize())
input_frame = frame_factory.build_headers_frame(
headers=self.example_trailers,
flags=["END_STREAM"],
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
stream_ended_event = events[1]
assert base_event.stream_ended is stream_ended_event
assert base_event.priority_updated is None
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_informational_response_related_nothing(self, frame_factory, request_headers) -> None:
"""
InformationalResponseReceived in the standard case is related to
nothing.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
input_frame = frame_factory.build_headers_frame(
headers=self.informational_response_headers,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 1
base_event = events[0]
assert base_event.priority_updated is None
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_informational_response_received_related_all(self, frame_factory, request_headers) -> None:
"""
InformationalResponseReceived has one possible related event:
PriorityUpdated, fired when a single HEADERS frame is received.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
input_frame = frame_factory.build_headers_frame(
headers=self.informational_response_headers,
flags=["PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
priority_updated_event = events[1]
assert base_event.priority_updated is priority_updated_event
assert isinstance(
base_event.priority_updated, h2.events.PriorityUpdated,
)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_data_received_normally_relates_to_nothing(self, frame_factory, request_headers) -> None:
"""
A plain DATA frame leads to DataReceieved with no related events.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
f = frame_factory.build_headers_frame(
headers=self.example_response_headers,
)
c.receive_data(f.serialize())
input_frame = frame_factory.build_data_frame(
data=b"some data",
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 1
base_event = events[0]
assert base_event.stream_ended is None
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_data_received_related_stream_ended(self, frame_factory, request_headers) -> None:
"""
DataReceived can be related to StreamEnded by itself.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(stream_id=1, headers=request_headers)
f = frame_factory.build_headers_frame(
headers=self.example_response_headers,
)
c.receive_data(f.serialize())
input_frame = frame_factory.build_data_frame(
data=b"some data",
flags=["END_STREAM"],
)
events = c.receive_data(input_frame.serialize())
assert len(events) == 2
base_event = events[0]
stream_ended_event = events[1]
assert base_event.stream_ended is stream_ended_event
assert isinstance(base_event.stream_ended, h2.events.StreamEnded)
|