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
|
from __future__ import annotations
import pytest
import h2.config
import h2.connection
import h2.errors
import h2.events
import h2.exceptions
import h2.stream
class TestPriority:
"""
Basic priority tests.
"""
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", "pytest-h2"),
]
server_config = h2.config.H2Configuration(client_side=False)
def test_receiving_priority_emits_priority_update(self, frame_factory) -> None:
"""
Receiving a priority frame emits a PriorityUpdated event.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_priority_frame(
stream_id=1,
weight=255,
)
events = c.receive_data(f.serialize())
assert len(events) == 1
assert not c.data_to_send()
event = events[0]
assert isinstance(event, h2.events.PriorityUpdated)
assert event.stream_id == 1
assert event.depends_on == 0
assert event.weight == 256
assert event.exclusive is False
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_headers_with_priority_info(self, frame_factory, request_headers) -> None:
"""
Receiving a HEADERS frame with priority information on it emits a
PriorityUpdated event.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_headers_frame(
headers=request_headers,
stream_id=3,
flags=["PRIORITY"],
stream_weight=15,
depends_on=1,
exclusive=True,
)
events = c.receive_data(f.serialize())
assert len(events) == 2
assert not c.data_to_send()
event = events[1]
assert isinstance(event, h2.events.PriorityUpdated)
assert event.stream_id == 3
assert event.depends_on == 1
assert event.weight == 16
assert event.exclusive is True
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_streams_may_not_depend_on_themselves(self, frame_factory, request_headers) -> None:
"""
A stream adjusted to depend on itself causes a Protocol Error.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_headers_frame(
headers=request_headers,
stream_id=3,
flags=["PRIORITY"],
stream_weight=15,
depends_on=1,
exclusive=True,
)
c.receive_data(f.serialize())
c.clear_outbound_data_buffer()
f = frame_factory.build_priority_frame(
stream_id=3,
depends_on=3,
weight=15,
)
with pytest.raises(h2.exceptions.ProtocolError):
c.receive_data(f.serialize())
expected_frame = frame_factory.build_goaway_frame(
last_stream_id=3,
error_code=h2.errors.ErrorCodes.PROTOCOL_ERROR,
)
assert c.data_to_send() == expected_frame.serialize()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
@pytest.mark.parametrize(
("depends_on", "weight", "exclusive"),
[
(0, 256, False),
(3, 128, False),
(3, 128, True),
],
)
def test_can_prioritize_stream(self, depends_on, weight, exclusive,
frame_factory, request_headers) -> None:
"""
hyper-h2 can emit priority frames.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.send_headers(headers=request_headers, stream_id=1)
c.send_headers(headers=request_headers, stream_id=3)
c.clear_outbound_data_buffer()
c.prioritize(
stream_id=1,
depends_on=depends_on,
weight=weight,
exclusive=exclusive,
)
f = frame_factory.build_priority_frame(
stream_id=1,
weight=weight - 1,
depends_on=depends_on,
exclusive=exclusive,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
@pytest.mark.parametrize(
("depends_on", "weight", "exclusive"),
[
(0, 256, False),
(1, 128, False),
(1, 128, True),
],
)
def test_emit_headers_with_priority_info(self, depends_on, weight,
exclusive, frame_factory, request_headers) -> None:
"""
It is possible to send a headers frame with priority information on
it.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
c.send_headers(
headers=request_headers,
stream_id=3,
priority_weight=weight,
priority_depends_on=depends_on,
priority_exclusive=exclusive,
)
f = frame_factory.build_headers_frame(
headers=request_headers,
stream_id=3,
flags=["PRIORITY"],
stream_weight=weight - 1,
depends_on=depends_on,
exclusive=exclusive,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_may_not_prioritize_stream_to_depend_on_self(self, frame_factory, request_headers) -> None:
"""
A stream adjusted to depend on itself causes a Protocol Error.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.send_headers(
headers=request_headers,
stream_id=3,
priority_weight=255,
priority_depends_on=0,
priority_exclusive=False,
)
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.prioritize(
stream_id=3,
depends_on=3,
)
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_may_not_initially_set_stream_depend_on_self(self, frame_factory, request_headers) -> None:
"""
A stream that starts by depending on itself causes a Protocol Error.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.send_headers(
headers=request_headers,
stream_id=3,
priority_depends_on=3,
)
assert not c.data_to_send()
@pytest.mark.parametrize("weight", [0, -15, 257])
def test_prioritize_requires_valid_weight(self, weight) -> None:
"""
A call to prioritize with an invalid weight causes a ProtocolError.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.prioritize(stream_id=1, weight=weight)
assert not c.data_to_send()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
@pytest.mark.parametrize("weight", [0, -15, 257])
def test_send_headers_requires_valid_weight(self, weight, request_headers) -> None:
"""
A call to send_headers with an invalid weight causes a ProtocolError.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
with pytest.raises(h2.exceptions.ProtocolError):
c.send_headers(
stream_id=1,
headers=request_headers,
priority_weight=weight,
)
assert not c.data_to_send()
def test_prioritize_defaults(self, frame_factory) -> None:
"""
When prioritize() is called with no explicit arguments, it emits a
weight of 16, depending on stream zero non-exclusively.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
c.prioritize(stream_id=1)
f = frame_factory.build_priority_frame(
stream_id=1,
weight=15,
depends_on=0,
exclusive=False,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
@pytest.mark.parametrize(
"priority_kwargs",
[
{"priority_weight": 16},
{"priority_depends_on": 0},
{"priority_exclusive": False},
],
)
def test_send_headers_defaults(self, priority_kwargs, frame_factory, request_headers) -> None:
"""
When send_headers() is called with only one explicit argument, it emits
default values for everything else.
"""
c = h2.connection.H2Connection()
c.initiate_connection()
c.clear_outbound_data_buffer()
c.send_headers(
stream_id=1,
headers=request_headers,
**priority_kwargs,
)
f = frame_factory.build_headers_frame(
headers=request_headers,
stream_id=1,
flags=["PRIORITY"],
stream_weight=15,
depends_on=0,
exclusive=False,
)
assert c.data_to_send() == f.serialize()
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_servers_cannot_prioritize(self, frame_factory, request_headers) -> None:
"""
Server stacks are not allowed to call ``prioritize()``.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_headers_frame(
stream_id=1,
headers=request_headers,
)
c.receive_data(f.serialize())
with pytest.raises(h2.exceptions.RFC1122Error):
c.prioritize(stream_id=1)
@pytest.mark.parametrize("request_headers", [example_request_headers, example_request_headers_bytes])
def test_servers_cannot_prioritize_with_headers(self, frame_factory, request_headers) -> None:
"""
Server stacks are not allowed to prioritize on headers either.
"""
c = h2.connection.H2Connection(config=self.server_config)
c.initiate_connection()
c.receive_data(frame_factory.preamble())
c.clear_outbound_data_buffer()
f = frame_factory.build_headers_frame(
stream_id=1,
headers=request_headers,
)
c.receive_data(f.serialize())
with pytest.raises(h2.exceptions.RFC1122Error):
c.send_headers(
stream_id=1,
headers=self.example_response_headers,
priority_weight=16,
)
|