Skip to content

Refuse a channel change while a pending dataset is in place #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agners merged 1 commit into from
Aug 24, 2026
Merged

Refuse a channel change while a pending dataset is in place #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions python_otbr_api/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ def _rewrite_keys(data: Any, mapping: dict[str, str]) -> Any:
return {mapping.get(k, k): _rewrite_keys(v, mapping) for k, v in data.items()}


class OTBR: # pylint: disable=too-few-public-methods
class OTBR: # pylint: disable=too-many-public-methods
"""Class to interact with the Open Thread Border Router REST API."""

def __init__(
Expand Down Expand Up @@ -378,10 +378,15 @@ async def set_channel(
"""Change the channel

The channel is changed by creating a new pending dataset based on the active
dataset.
dataset. If a pending dataset is already in place, the change is refused:
stamping from the active dataset alone would make the mesh silently ignore
it while the router accepts the write, and superseding the pending dataset
would race its delay timer on devices that miss the update.
"""
if not 11 <= channel <= 26:
raise OTBRError(f"invalid channel {channel}")
if await self.get_pending_dataset_tlvs() is not None:
raise OTBRError("a pending dataset is already in place")
if not (dataset := await self.get_active_dataset()):
raise OTBRError("router has no active dataset")

Expand Down
65 changes: 50 additions & 15 deletions tests/test_init_legacy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ async def test_set_channel(aioclient_mock: AiohttpClientMocker) -> None:
)

aioclient_mock.get(f"{BASE_URL}/node/dataset/active", json=DATASET_JSON)
aioclient_mock.get(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.NO_CONTENT)
aioclient_mock.put(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.CREATED)
new_channel = 16
expected_active_timestamp = DATASET_JSON["ActiveTimestamp"] | {"Seconds": 2}
Expand All @@ -390,12 +391,14 @@ async def test_set_channel(aioclient_mock: AiohttpClientMocker) -> None:

assert new_channel != DATASET_JSON["Channel"]
await otbr.set_channel(new_channel, 1234)
assert aioclient_mock.call_count == 2
assert aioclient_mock.call_count == 3
assert aioclient_mock.mock_calls[0][0] == "GET"
assert aioclient_mock.mock_calls[0][1].path == "/node/dataset/active"
assert aioclient_mock.mock_calls[1][0] == "PUT"
assert aioclient_mock.mock_calls[1][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[1][2] == expected_pending_dataset
assert aioclient_mock.mock_calls[0][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[1][0] == "GET"
assert aioclient_mock.mock_calls[1][1].path == "/node/dataset/active"
assert aioclient_mock.mock_calls[2][0] == "PUT"
assert aioclient_mock.mock_calls[2][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[2][2] == expected_pending_dataset


async def test_set_channel_default_delay(aioclient_mock: AiohttpClientMocker) -> None:
Expand All @@ -405,6 +408,7 @@ async def test_set_channel_default_delay(aioclient_mock: AiohttpClientMocker) ->
)

aioclient_mock.get(f"{BASE_URL}/node/dataset/active", json=DATASET_JSON)
aioclient_mock.get(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.NO_CONTENT)
aioclient_mock.put(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.CREATED)
new_channel = 16
expected_active_timestamp = DATASET_JSON["ActiveTimestamp"] | {"Seconds": 2}
Expand All @@ -419,12 +423,14 @@ async def test_set_channel_default_delay(aioclient_mock: AiohttpClientMocker) ->

assert new_channel != DATASET_JSON["Channel"]
await otbr.set_channel(new_channel)
assert aioclient_mock.call_count == 2
assert aioclient_mock.call_count == 3
assert aioclient_mock.mock_calls[0][0] == "GET"
assert aioclient_mock.mock_calls[0][1].path == "/node/dataset/active"
assert aioclient_mock.mock_calls[1][0] == "PUT"
assert aioclient_mock.mock_calls[1][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[1][2] == expected_pending_dataset
assert aioclient_mock.mock_calls[0][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[1][0] == "GET"
assert aioclient_mock.mock_calls[1][1].path == "/node/dataset/active"
assert aioclient_mock.mock_calls[2][0] == "PUT"
assert aioclient_mock.mock_calls[2][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[2][2] == expected_pending_dataset


async def test_set_channel_no_timestamp(aioclient_mock: AiohttpClientMocker) -> None:
Expand All @@ -437,6 +443,7 @@ async def test_set_channel_no_timestamp(aioclient_mock: AiohttpClientMocker) ->
dataset_json.pop("ActiveTimestamp")

aioclient_mock.get(f"{BASE_URL}/node/dataset/active", json=dataset_json)
aioclient_mock.get(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.NO_CONTENT)
aioclient_mock.put(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.CREATED)
new_channel = 16
expected_active_timestamp = {"Authoritative": False, "Seconds": 1, "Ticks": 0}
Expand All @@ -451,12 +458,14 @@ async def test_set_channel_no_timestamp(aioclient_mock: AiohttpClientMocker) ->

assert new_channel != DATASET_JSON["Channel"]
await otbr.set_channel(new_channel)
assert aioclient_mock.call_count == 2
assert aioclient_mock.call_count == 3
assert aioclient_mock.mock_calls[0][0] == "GET"
assert aioclient_mock.mock_calls[0][1].path == "/node/dataset/active"
assert aioclient_mock.mock_calls[1][0] == "PUT"
assert aioclient_mock.mock_calls[1][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[1][2] == expected_pending_dataset
assert aioclient_mock.mock_calls[0][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[1][0] == "GET"
assert aioclient_mock.mock_calls[1][1].path == "/node/dataset/active"
assert aioclient_mock.mock_calls[2][0] == "PUT"
assert aioclient_mock.mock_calls[2][1].path == "/node/dataset/pending"
assert aioclient_mock.mock_calls[2][2] == expected_pending_dataset


async def test_set_channel_invalid_channel(aioclient_mock: AiohttpClientMocker) -> None:
Expand All @@ -475,12 +484,38 @@ async def test_set_channel_no_dataset(aioclient_mock: AiohttpClientMocker) -> No
BASE_URL, aioclient_mock.create_session(), key_format=KeyFormat.PASCAL_CASE
)

aioclient_mock.get(f"{BASE_URL}/node/dataset/pending", status=HTTPStatus.NO_CONTENT)
aioclient_mock.get(f"{BASE_URL}/node/dataset/active", status=HTTPStatus.NO_CONTENT)

with pytest.raises(python_otbr_api.OTBRError):
await otbr.set_channel(16)


async def test_set_channel_rejected_while_pending(
aioclient_mock: AiohttpClientMocker,
) -> None:
"""A channel change is refused while a pending dataset is in place.

Stamping from the active dataset alone would make the mesh silently ignore
the write, and superseding the pending dataset would race its delay timer
on devices that miss the update; refusing is the only honest answer.
"""
otbr = python_otbr_api.OTBR(
BASE_URL, aioclient_mock.create_session(), key_format=KeyFormat.PASCAL_CASE
)

mock_response = (
"0E080000000000010000340400006699000300000C35060004001FFFE00208057B7CD3D6CC9F65"
"0708FD17C9D59809B27A05107546326F20BCCFD946609FBAF7F39AD5030F4F70656E5468726561"
"642D32366363010226CC0410FA7EC34EBE58DD1FD74F13F65D021C5B0C0402A0F7F8"
)
aioclient_mock.get(f"{BASE_URL}/node/dataset/pending", text=mock_response)

with pytest.raises(python_otbr_api.OTBRError):
await otbr.set_channel(16)
assert aioclient_mock.call_count == 1


async def test_get_extended_address(aioclient_mock: AiohttpClientMocker) -> None:
"""Test get_active_dataset_tlvs."""
otbr = python_otbr_api.OTBR(
Expand Down