ScatteredBuffer::IFragmentsObserver (#440)

- Fix unit tests broken by recent changes at CETL (`std::bad_alloc` at
`VariableLengthArray`).

Author: serges147

.clang-tidy

@@ -12,6 +12,7 @@ Checks: >-
   performance-*,
   portability-*,
   readability-*,
+  -boost-use-ranges,
   -clang-analyzer-core.uninitialized.Assign,
   -cppcoreguidelines-avoid-const-or-ref-data-members,
   -cppcoreguidelines-use-default-member-init,
@@ -22,7 +23,9 @@ Checks: >-
   -modernize-type-traits,
   -modernize-use-constraints,
   -modernize-use-default-member-init,
+  -modernize-use-designated-initializers,
   -modernize-use-nodiscard,
+  -modernize-use-ranges,
   -readability-avoid-const-params-in-decls,
   -readability-identifier-length,
   -*-use-trailing-return-type,

.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 {
     "name": "linux development environment for libcyphal",
-    "image": "ghcr.io/opencyphal/toolshed:ts22.4.10",
+    "image": "ghcr.io/opencyphal/toolshed:ts24.4.3",
     "customizations": {
         "vscode": {
             "extensions": [

.github/workflows/sonar.yml

@@ -15,14 +15,14 @@ jobs:
       contains(github.ref, '/issue/') ||
       (github.event_name == 'pull_request')
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toolshed:ts22.4.10
+    container: ghcr.io/opencyphal/toolshed:ts24.4.3
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
       - name: get nunavut
-        run: >
-          pip install git+https://github.com/OpenCyphal/[email protected]
+        run: |
+          pip install --break-system-packages git+https://github.com/OpenCyphal/[email protected]
       - name: Install sonar-scanner and build-wrapper
         uses: SonarSource/sonarcloud-github-c-cpp@v2
       - name: Run tests

.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
       contains(github.ref, '/issue/') ||
       (github.event_name == 'pull_request')
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toolshed:ts22.4.10
+    container: ghcr.io/opencyphal/toolshed:ts24.4.3
     steps:
       - uses: actions/checkout@v4
       - name: Cache ext modules
@@ -29,8 +29,8 @@ jobs:
           key: ${{ runner.os }}-${{ hashFiles('cmake/modules/*.cmake') }}
       - name: get nunavut
         # TODO: setup a venv, cache, and distribute to the other jobs.
-        run: >
-          pip install git+https://github.com/OpenCyphal/[email protected]
+        run: |
+          pip install --break-system-packages git+https://github.com/OpenCyphal/[email protected]
       - name: configure
         run: >
           ./build-tools/bin/verify.py
@@ -47,7 +47,7 @@ jobs:
       contains(github.ref, '/issue/') ||
       (github.event_name == 'pull_request')
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toolshed:ts22.4.10
+    container: ghcr.io/opencyphal/toolshed:ts24.4.3
     needs: [warmup]
     strategy:
       matrix:
@@ -69,8 +69,8 @@ jobs:
         path: external
         key: ${{ runner.os }}-${{ hashFiles('cmake/modules/*.cmake') }}
     - name: get nunavut
-      run: >
-        pip install git+https://github.com/OpenCyphal/[email protected]
+      run: |
+        pip install --break-system-packages git+https://github.com/OpenCyphal/[email protected]
     - name: run tests
       env:
         GTEST_COLOR: yes
@@ -101,7 +101,7 @@ jobs:
       contains(github.ref, '/issue/') ||
       (github.event_name == 'pull_request')
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toolshed:ts22.4.10
+    container: ghcr.io/opencyphal/toolshed:ts24.4.3
     needs: [warmup]
     steps:
     - uses: actions/checkout@v4
@@ -114,8 +114,8 @@ jobs:
         path: external
         key: ${{ runner.os }}-${{ hashFiles('cmake/modules/*.cmake') }}
     - name: get nunavut
-      run: >
-        pip install git+https://github.com/OpenCyphal/[email protected]
+      run: |
+        pip install --break-system-packages git+https://github.com/OpenCyphal/[email protected]
     - name: doc-gen
       run: >
         ./build-tools/bin/verify.py

CONTRIBUTING.md

@@ -147,10 +147,10 @@ and manually run it.
 
 ### TLDR
 ```
-docker pull ghcr.io/opencyphal/toolshed:ts22.4.10
+docker pull ghcr.io/opencyphal/toolshed:ts24.4.3
 git clone {this repo}
 cd {this repo}
-docker run --rm -it -v ${PWD}:/repo ghcr.io/opencyphal/toolshed:ts22.4.10
+docker run --rm -it -v ${PWD}:/repo ghcr.io/opencyphal/toolshed:ts24.4.3
 mkdir build
 cd build
 cmake ..
@@ -200,7 +200,7 @@ To ensure that the formatting matches the expectations of the CI suite,
 invoke Clang-Format of the correct version from the container (be sure to use the correct image tag):
 
 ```
-docker run --rm -v ${PWD}:/repo ghcr.io/opencyphal/toolshed:ts22.4.10 ./build-tools/bin/verify.py build-danger-danger-repo-clang-format-in-place
+docker run --rm -v ${PWD}:/repo ghcr.io/opencyphal/toolshed:ts24.4.3 ./build-tools/bin/verify.py build-danger-danger-repo-clang-format-in-place
 ```
 
 ### `issue/*` and hashtag-based CI triggering

docs/examples/1_presentation/example_1_presentation_0_hello_raw_pubsub_udp.cpp

@@ -151,8 +151,8 @@ TEST_F(Example_1_Presentation_0_HelloRawPubSub_Udp, main)
         const TimePoint                  msg_deadline = arg.approx_now + 1s;
         constexpr cetl::span<const char> message{"Hello, World!"};
         //
-        const std::array<const cetl::span<const cetl::byte>, 1> payload_fragments{
-            cetl::span<const cetl::byte>{reinterpret_cast<const cetl::byte*>(message.data()),  // NOLINT
+        const std::array<const PayloadFragment, 1> payload_fragments{
+            PayloadFragment{reinterpret_cast<const cetl::byte*>(message.data()),  // NOLINT
                                          message.size()}};
         EXPECT_THAT(raw_publisher.publish(msg_deadline, payload_fragments), testing::Eq(cetl::nullopt));
     });

docs/examples/1_presentation/example_1_presentation_2_heartbeat_getinfo_udp.cpp

@@ -176,7 +176,7 @@ TEST_F(Example_1_Presentation_2_Heartbeat_GetInfo_Udp, main)
 
     // Bring up 'GetInfo' server.
     //
-    using GetInfo_1_0 = uavcan::node::GetInfo_1_0;
+    using uavcan::node::GetInfo_1_0;
     const std::string node_name{"org.opencyphal.Ex_1_Pres_2_HB_GetInfo_UDP"};
     std::copy_n(node_name.begin(), std::min(node_name.size(), 50UL), std::back_inserter(state.get_info_response.name));
     //

docs/examples/1_presentation/example_1_presentation_3_hb_getinfo_ping_linux_can.cpp

@@ -424,8 +424,8 @@ TEST_F(Example_1_Presentation_3_HB_GetInfo_Ping_Can, main)
 
     // 7. Bring up 'GetInfo' server.
     //
-    using GetInfo_1_0 = uavcan::node::GetInfo_1_0;
-    uavcan::node::GetInfo_1_0::Response get_info_response{{&mr_}};
+    using uavcan::node::GetInfo_1_0;
+    GetInfo_1_0::Response get_info_response{{&mr_}};
     get_info_response.protocol_version.major = 1;
     const std::string node_name{"org.opencyphal.Ex_1_Pres_3_HB_GetInfo_Ping_CAN"};
     std::copy_n(node_name.begin(), std::min(node_name.size(), 50UL), std::back_inserter(get_info_response.name));

docs/examples/platform/node_helpers.hpp

@@ -70,13 +70,15 @@ struct NodeHelpers
                                                                              const TxMetadata& metadata)
     {
         using traits = typename T::_traits_;
+        using libcyphal::transport::PayloadFragment;
+
         std::array<std::uint8_t, traits::SerializationBufferSizeBytes> buffer{};
 
         const auto data_size = serialize(value, buffer).value();
 
         // NOLINTNEXTLINE
-        const cetl::span<const cetl::byte> fragment{reinterpret_cast<cetl::byte*>(buffer.data()), data_size};
-        const std::array<const cetl::span<const cetl::byte>, 1> payload{fragment};
+        const PayloadFragment                      fragment{reinterpret_cast<cetl::byte*>(buffer.data()), data_size};
+        const std::array<const PayloadFragment, 1> payload{fragment};
 
         return tx_session.send(metadata, payload);
     }

include/libcyphal/common/cavl/cavl.hpp

@@ -81,12 +81,12 @@ class Node  // NOSONAR cpp:S1448
     using DerivedType = Derived;
 
     // Tree nodes cannot be copied for obvious reasons.
-    Node(const Node&)                    = delete;
+    Node(const Node&)                    = delete;  // NOLINT bugprone-crtp-constructor-accessibility
     auto operator=(const Node&) -> Node& = delete;
 
     // Tree nodes can be moved. We update the pointers in the adjacent nodes to keep the tree valid,
     // as well as root node pointer if needed (see `moveFrom`). This operation is constant time.
-    Node(Node&& other) noexcept
+    Node(Node&& other) noexcept  // NOLINT bugprone-crtp-constructor-accessibility
     {
         moveFrom(other);
     }
@@ -102,7 +102,7 @@ class Node  // NOSONAR cpp:S1448
     }
 
 protected:
-    Node()  = default;
+    Node()  = default;  // NOLINT bugprone-crtp-constructor-accessibility
     ~Node() = default;
 
     /// Accessors for advanced tree introspection. Not needed for typical usage.