pychrony 2.0.2__tar.gz → 2.0.3__tar.gz

{pychrony-2.0.2 → pychrony-2.0.3}/.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
         with:
           enable-cache: true
           python-version: ${{ matrix.python-version }}
@@ -59,7 +59,7 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
         with:
           enable-cache: true
           python-version: "3.12"
@@ -87,7 +87,7 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+        uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
         with:
           enable-cache: true
           python-version: "3.12"
@@ -127,10 +127,12 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
 
-      # chronyd answers commands before it has resolved its pool and server
-      # names, and the source list grows as each name resolves. Tests that
+      # chronyd answers commands before it has resolved its server name, and
+      # the source list changes as the name resolves. Tests that
       # walk the source list race that growth, so wait until no source has an
       # unresolved address. chronyc also fails until the command socket is up.
+      # The 40s limit covers one failed DNS lookup: chronyd retries unresolved
+      # names 28s after its first attempt.
       - name: Run tests
         run: |
           docker run --rm --cap-add=SYS_TIME pychrony-test:latest sh -c '
@@ -138,8 +140,8 @@ jobs:
             i=0
             until chronyc -n activity 2>/dev/null | grep -q "^0 sources with unknown address"; do
               i=$((i + 1))
-              if [ "$i" -ge 40 ]; then
-                echo "chronyd sources not resolved after 20s"
+              if [ "$i" -ge 80 ]; then
+                echo "chronyd sources not resolved after 40s"
                 chronyc -n activity
                 exit 1
               fi

{pychrony-2.0.2 → pychrony-2.0.3}/.github/workflows/docs.yml

@@ -29,7 +29,7 @@ jobs:
         persist-credentials: true
 
     - name: Install UV
-      uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+      uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
       with:
         # A deploy job must not restore a cache that a PR run could have written.
         enable-cache: false

{pychrony-2.0.2 → pychrony-2.0.3}/.github/workflows/release.yml

@@ -35,14 +35,14 @@ jobs:
         persist-credentials: false
 
     - name: Build wheels with cibuildwheel
-      uses: pypa/cibuildwheel@e090b81e30c4d855ea63bf4b6e59204c09a101ae # v4.2.1
+      uses: pypa/cibuildwheel@adba99c781d3746d38b3a09b1cf797965bcb7fe6 # v4.3.0
       with:
         extras: uv
       env:
         CIBW_ARCHS_LINUX: ${{ matrix.arch }}
 
     - name: Upload wheel artifacts
-      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+      uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
       with:
         name: wheels-${{ matrix.arch }}
         path: wheelhouse/*.whl
@@ -59,7 +59,7 @@ jobs:
         persist-credentials: false
 
     - name: Install UV
-      uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
+      uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
       with:
         # The sdist ships to PyPI, so it must not build from a cache that a PR
         # run could have written.
@@ -69,7 +69,7 @@ jobs:
       run: uv build --sdist
 
     - name: Upload sdist artifact
-      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+      uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
       with:
         name: sdist
         path: dist/*.tar.gz
@@ -86,7 +86,7 @@ jobs:
 
     steps:
     - name: Download all artifacts
-      uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+      uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
       with:
         path: dist/
         merge-multiple: true
@@ -169,7 +169,7 @@ jobs:
 
     steps:
     - name: Download all artifacts
-      uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+      uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
       with:
         path: dist/
         merge-multiple: true

{pychrony-2.0.2/src/pychrony.egg-info → pychrony-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pychrony
-Version: 2.0.2
+Version: 2.0.3
 Summary: Python bindings for chrony NTP client
 Author-email: arunderwood <arunderwood@users.noreply.github.com>
 License-Expression: MIT AND LGPL-2.1-or-later

{pychrony-2.0.2 → pychrony-2.0.3}/TESTING.md

@@ -238,6 +238,7 @@ Key fields:
 - `reference_id`: Reference identifier (uint32)
 - `leap_status`: `LeapStatus` enum value
 - `sources`: List of `SourceConfig` instances
+- `source_list_changes`: Source lists chronyd moves to, one per source count it answers (see [Source List Changes](#source-list-changes))
 - `rtc`: Optional `RTCConfig` for RTC data
 - `error_injection`: Dict for injecting errors
 
@@ -341,6 +342,31 @@ def test_permission_error():
         pass
 ```
 
+### Source List Changes
+
+chronyd adds and removes sources while it resolves `pool` and `server` names,
+and when it replaces unreachable pool servers. A record count can then be
+stale by the time a record is requested. The mock models this the way libchrony
+behaves: the count is fixed when its response arrives, and a record request past
+the end of the current list fails with `CHRONY_UNEXPECTED_STATUS`.
+
+`source_list_changes` holds the lists chronyd moves to, in order. The mock takes
+the next one right after it answers each `sources` or `sourcestats` count:
+
+```python
+config = ChronyStateConfig(
+    sources=[SourceConfig(address=a) for a in ("10.0.0.1", "10.0.0.2", "10.0.0.3")],
+    # After the first count (3), one source is gone: record 2 no longer exists.
+    source_list_changes=[[SourceConfig(address=a) for a in ("10.0.0.1", "10.0.0.2")]],
+)
+
+with patched_chrony_connection(config) as conn:
+    assert len(conn.get_sources()) == 2
+```
+
+The mock copies `sources` and `source_list_changes` per connection, so shared
+scenarios are never modified.
+
 ### Custom Scenarios
 
 Create custom scenarios for specific test needs:

{pychrony-2.0.2 → pychrony-2.0.3}/docker/Dockerfile.test

@@ -46,7 +46,12 @@ RUN mkdir -p /run/chrony && chown chrony:chrony /run/chrony && chmod 750 /run/ch
 # The command port stays at its default (323 on localhost) so the auto-detect
 # fallback from the Unix socket can be exercised; "cmdport 0" would make that
 # path untestable.
-RUN echo "local stratum 10" >> /etc/chrony.conf && \
+# Fedora's stock "pool" line is removed so the only NTP source is the single
+# "server" below. A pool starts as 8 placeholders that need several DNS
+# answers to fill, and chronyd waits 28s before retrying a partial fill,
+# which outlasts the CI readiness gate.
+RUN sed -i '/^pool /d' /etc/chrony.conf && \
+    echo "local stratum 10" >> /etc/chrony.conf && \
     echo "allow 127.0.0.1" >> /etc/chrony.conf && \
     echo "cmdallow 127.0.0.1" >> /etc/chrony.conf && \
     echo "bindcmdaddress /run/chrony/chronyd.sock" >> /etc/chrony.conf && \

{pychrony-2.0.2 → pychrony-2.0.3}/src/pychrony/_core/_bindings.py

@@ -8,8 +8,9 @@ Internal implementation - use pychrony.ChronyConnection instead.
 
 import math
 import os
+from collections.abc import Callable
 from types import TracebackType
-from typing import Any, NoReturn
+from typing import Any, NoReturn, TypeVar
 
 from ..exceptions import (
     ChronyConnectionError,
@@ -29,6 +30,8 @@ from ..models import (
     _ref_id_to_name,
 )
 
+_T = TypeVar("_T")
+
 # Unix socket paths tried during auto-detect, in order. chrony documents its
 # compiled-in default as /run/... or /var/run/... depending on release; the two
 # are the same file wherever /var/run symlinks to /run.
@@ -74,15 +77,27 @@ except ImportError:
 # rather than its data being bad. Taken from the compiled bindings so that an
 # enumerator added upstream cannot silently shift them into misclassifying
 # errors. The literals apply only with no bindings, where nothing is classified.
+#
+# CHRONY_UNEXPECTED_STATUS is how a request for a source index past the end of
+# chronyd's list comes back: chronyd answers STT_NOSUCHSOURCE, which libchrony
+# has no case for.
 if _LIBRARY_AVAILABLE:
     CHRONY_SEND_FAILED = _lib.CHRONY_SEND_FAILED
     CHRONY_RECV_FAILED = _lib.CHRONY_RECV_FAILED
+    CHRONY_UNEXPECTED_STATUS = _lib.CHRONY_UNEXPECTED_STATUS
 else:
     CHRONY_SEND_FAILED = 5
     CHRONY_RECV_FAILED = 6
+    CHRONY_UNEXPECTED_STATUS = 11
 
 TRANSPORT_ERRORS = frozenset({CHRONY_SEND_FAILED, CHRONY_RECV_FAILED})
 
+# Reads of a per-source report before the last failure is raised. chronyd adds
+# and removes sources while it resolves pool and server names, and when it
+# replaces unreachable pool servers, so the record count can be stale by the
+# time a record is requested. Each read starts over from a fresh count.
+SOURCE_LIST_READ_ATTEMPTS = 3
+
 
 def _is_unix_socket_address(address: str) -> bool:
     """Return True if an address names a Unix socket path.
@@ -539,6 +554,58 @@ class ChronyConnection:
                     f"Failed to process {report_name.decode()} record {index}", err
                 )
 
+    def _read_records(
+        self, report_name: bytes, read_record: Callable[[], _T]
+    ) -> list[_T]:
+        """Read every record of a report, one request per record.
+
+        Args:
+            report_name: Report name (e.g., b"sources")
+            read_record: Extracts and validates the record the session holds
+
+        Returns:
+            One read_record result per record, in index order
+
+        Raises:
+            ChronyConnectionError: If chronyd could not be reached
+            ChronyDataError: If a record could not be retrieved or is invalid
+        """
+        records = []
+        for index in range(self._request_report(report_name)):
+            self._request_record(report_name, index)
+            records.append(read_record())
+        return records
+
+    def _read_source_list(
+        self, report_name: bytes, read_record: Callable[[], _T]
+    ) -> list[_T]:
+        """Read a per-source report, starting over if the source list changes.
+
+        A shrinking list shows up as CHRONY_UNEXPECTED_STATUS on a record
+        request. libchrony uses that code for every chronyd status it does not
+        know, so a failure that is not a list change also gets retried, and
+        then raised once the attempts run out.
+
+        Args:
+            report_name: Report name (b"sources" or b"sourcestats")
+            read_record: Extracts and validates the record the session holds
+
+        Returns:
+            One read_record result per source, in index order
+
+        Raises:
+            ChronyConnectionError: If chronyd could not be reached
+            ChronyDataError: If a record is invalid, or could not be retrieved
+                on any of SOURCE_LIST_READ_ATTEMPTS reads
+        """
+        for _ in range(SOURCE_LIST_READ_ATTEMPTS - 1):
+            try:
+                return self._read_records(report_name, read_record)
+            except ChronyDataError as e:
+                if e.error_code != CHRONY_UNEXPECTED_STATUS:
+                    raise
+        return self._read_records(report_name, read_record)
+
     def get_tracking(self) -> TrackingStatus:
         """Get current tracking status from chronyd.
 
@@ -650,19 +717,13 @@ class ChronyConnection:
             ...         print(f"{src.address}: stratum {src.stratum}")
         """
         self._ensure_context()
+        return self._read_source_list(b"sources", self._read_source)
 
-        num_records = self._request_report(b"sources")
-        if num_records < 1:
-            return []
-
-        sources = []
-        for i in range(num_records):
-            self._request_record(b"sources", i)
-            data = self._extract_source()
-            self._validate_source(data)
-            sources.append(Source(**data))
-
-        return sources
+    def _read_source(self) -> Source:
+        """Build a Source from the current session record."""
+        data = self._extract_source()
+        self._validate_source(data)
+        return Source(**data)
 
     def _extract_source(self) -> dict:
         """Extract source fields from the current session record."""
@@ -745,19 +806,13 @@ class ChronyConnection:
             ...         print(f"{s.address}: {s.samples} samples")
         """
         self._ensure_context()
+        return self._read_source_list(b"sourcestats", self._read_sourcestats)
 
-        num_records = self._request_report(b"sourcestats")
-        if num_records < 1:
-            return []
-
-        stats = []
-        for i in range(num_records):
-            self._request_record(b"sourcestats", i)
-            data = self._extract_sourcestats()
-            self._validate_sourcestats(data)
-            stats.append(SourceStats(**data))
-
-        return stats
+    def _read_sourcestats(self) -> SourceStats:
+        """Build a SourceStats from the current session record."""
+        data = self._extract_sourcestats()
+        self._validate_sourcestats(data)
+        return SourceStats(**data)
 
     def _extract_sourcestats(self) -> dict:
         """Extract sourcestats fields from the current session record."""

{pychrony-2.0.2 → pychrony-2.0.3}/src/pychrony/_core/_build_bindings.py

@@ -23,6 +23,7 @@ typedef enum {
     CHRONY_OK,
     CHRONY_SEND_FAILED,
     CHRONY_RECV_FAILED,
+    CHRONY_UNEXPECTED_STATUS,
     ...
 } chrony_err;
 

{pychrony-2.0.2 → pychrony-2.0.3/src/pychrony.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pychrony
-Version: 2.0.2
+Version: 2.0.3
 Summary: Python bindings for chrony NTP client
 Author-email: arunderwood <arunderwood@users.noreply.github.com>
 License-Expression: MIT AND LGPL-2.1-or-later

{pychrony-2.0.2 → pychrony-2.0.3}/src/pychrony.egg-info/SOURCES.txt

@@ -133,6 +133,7 @@ tests/unit/test_mock_config.py
 tests/unit/test_mock_scenarios.py
 tests/unit/test_models.py
 tests/unit/test_rtc_scenarios.py
+tests/unit/test_source_list_changes.py
 tests/unit/test_source_scenarios.py
 tests/unit/test_testing.py
 tests/unit/test_validation.py

{pychrony-2.0.2 → pychrony-2.0.3}/src/pychrony.egg-info/scm_file_list.json

@@ -126,6 +126,7 @@
     "tests/unit/test_mock_scenarios.py",
     "tests/unit/test_models.py",
     "tests/unit/test_rtc_scenarios.py",
+    "tests/unit/test_source_list_changes.py",
     "tests/unit/test_source_scenarios.py",
     "tests/unit/test_testing.py",
     "tests/unit/test_validation.py",

pychrony-2.0.3/src/pychrony.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2.0.3",
+  "distance": 0,
+  "node": "g272927cd1d5b1021a26967247d4def5b2a8335d3",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-21"
+}

{pychrony-2.0.2 → pychrony-2.0.3}/tests/mocks/config.py

@@ -212,6 +212,9 @@ class ChronyStateConfig:
         root_dispersion: Root dispersion in seconds
         update_interval: Update interval in seconds
         sources: List of source configurations
+        source_list_changes: Source lists chronyd moves to, in order, one
+            each time it answers a sources or sourcestats count. Simulates
+            sources added or removed between the count and the record requests.
         rtc: RTC configuration (None if not available)
         error_injection: Map of operation names to error codes
     """
@@ -233,6 +236,7 @@ class ChronyStateConfig:
 
     # Sub-configurations
     sources: list[SourceConfig] = field(default_factory=list)
+    source_list_changes: list[list[SourceConfig]] = field(default_factory=list)
     rtc: RTCConfig | None = None
 
     # Error injection

{pychrony-2.0.2 → pychrony-2.0.3}/tests/mocks/session.py

@@ -9,6 +9,7 @@ from __future__ import annotations
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any
 
+from pychrony._core._bindings import CHRONY_UNEXPECTED_STATUS
 from pychrony._core._fields import (
     RTC_FIELDS,
     SOURCE_FIELDS,
@@ -18,9 +19,12 @@ from pychrony._core._fields import (
 )
 
 if TYPE_CHECKING:
-    from tests.mocks.config import ChronyStateConfig
+    from tests.mocks.config import ChronyStateConfig, SourceConfig
 
 
+# Reports whose records are chronyd's sources, one record per source.
+SOURCE_REPORTS = frozenset({"sources", "sourcestats"})
+
 __all__ = [
     "MockTimespec",
     "MockFFI",
@@ -153,6 +157,7 @@ class MockLib:
             return error
 
         self._session.current_report = report_name.decode("utf-8")
+        self._session.count_requested = True
         self._session.pending_responses = 1
         return 0
 
@@ -161,29 +166,35 @@ class MockLib:
         return self._session.pending_responses > 0
 
     def chrony_process_response(self, session: Any) -> int:
-        """Mock chrony_process_response."""
+        """Mock chrony_process_response.
+
+        Like libchrony, the record count is fixed when the count response
+        arrives, and a record request past the end of the source list fails
+        here with CHRONY_UNEXPECTED_STATUS.
+        """
         error = self._session.config.error_injection.get("chrony_process_response")
         if error is not None:
             return error
 
-        if self._session.pending_responses > 0:
-            self._session.pending_responses -= 1
+        session_state = self._session
+        if session_state.pending_responses == 0:
+            return 0
+        session_state.pending_responses -= 1
+
+        if session_state.count_requested:
+            session_state.num_records = session_state.count_records()
+            if session_state.current_report in SOURCE_REPORTS:
+                session_state.advance_source_list()
+        elif (
+            session_state.current_report in SOURCE_REPORTS
+            and session_state.current_record_index >= len(session_state.sources)
+        ):
+            return CHRONY_UNEXPECTED_STATUS
         return 0
 
     def chrony_get_report_number_records(self, session: Any) -> int:
         """Mock chrony_get_report_number_records."""
-        report = self._session.current_report
-        config = self._session.config
-
-        if report == "tracking":
-            return 1
-        elif report == "sources" or report == "sourcestats":
-            return len(config.sources)
-        elif report == "rtcdata":
-            if config.rtc is not None and config.rtc.available:
-                return 1
-            return 0
-        return 0
+        return self._session.num_records
 
     def chrony_request_record(
         self, session: Any, report_name: bytes, index: int
@@ -194,6 +205,7 @@ class MockLib:
             return error
 
         self._session.current_record_index = index
+        self._session.count_requested = False
         self._session.pending_responses = 1
         return 0
 
@@ -216,8 +228,8 @@ class MockLib:
             # which dynamically resolves to "address" (mode != 2) or "reference ID" (mode == 2)
             if name == "address":
                 record_idx = self._session.current_record_index
-                if record_idx < len(self._session.config.sources):
-                    source = self._session.config.sources[record_idx]
+                if record_idx < len(self._session.sources):
+                    source = self._session.sources[record_idx]
                     # Import SourceMode here to avoid circular import
                     from pychrony.models import SourceMode
 
@@ -266,8 +278,12 @@ class MockChronySession:
 
     Attributes:
         config: Configuration driving mock behavior
+        sources: chronyd's current source list. Starts as config.sources and
+            steps through config.source_list_changes.
         current_report: Currently active report name
         current_record_index: Current record being accessed
+        count_requested: Whether the outstanding request is a record count
+        num_records: Record count from the last count response
         pending_responses: Number of responses pending
         lib: Mock _lib object
         ffi: Mock _ffi object
@@ -275,12 +291,38 @@ class MockChronySession:
 
     def __init__(self, config: ChronyStateConfig) -> None:
         self.config = config
+        # Copies, so that stepping through source list changes leaves the
+        # config untouched: scenarios are shared module-level instances.
+        self.sources: list[SourceConfig] = list(config.sources)
+        self._source_list_changes = list(config.source_list_changes)
         self.current_report: str | None = None
         self.current_record_index: int = 0
+        self.count_requested: bool = False
+        self.num_records: int = 0
         self.pending_responses: int = 0
         self.lib = MockLib(self)
         self.ffi = MockFFI()
 
+    def count_records(self) -> int:
+        """Return the record count chronyd reports for the current report."""
+        report = self.current_report
+
+        if report == "tracking":
+            return 1
+        elif report in SOURCE_REPORTS:
+            return len(self.sources)
+        elif report == "rtcdata":
+            rtc = self.config.rtc
+            if rtc is not None and rtc.available:
+                return 1
+            return 0
+        return 0
+
+    def advance_source_list(self) -> None:
+        """Move chronyd's source list to the next configured change, if any."""
+        if self._source_list_changes:
+            self.sources = list(self._source_list_changes.pop(0))
+
     def get_field_value(self, index: int, field_type: FieldType) -> Any:
         """Get field value for current report and record.
 
@@ -335,13 +377,12 @@ class MockChronySession:
 
     def _get_source_field(self, index: int) -> Any:
         """Get sources report field by index."""
-        config = self.config
         record_idx = self.current_record_index
 
-        if record_idx >= len(config.sources):
+        if record_idx >= len(self.sources):
             return 0
 
-        source = config.sources[record_idx]
+        source = self.sources[record_idx]
         fields = list(SOURCE_FIELDS.keys())
 
         if index >= len(fields):
@@ -373,13 +414,12 @@ class MockChronySession:
 
     def _get_sourcestats_field(self, index: int) -> Any:
         """Get sourcestats report field by index."""
-        config = self.config
         record_idx = self.current_record_index
 
-        if record_idx >= len(config.sources):
+        if record_idx >= len(self.sources):
             return 0
 
-        source = config.sources[record_idx]
+        source = self.sources[record_idx]
         fields = list(SOURCESTATS_FIELDS.keys())
 
         if index >= len(fields):