This document is a declaration of software quality for the eProsima Micro XRCE-DDS Client based on the guidelines provided in the ROS 2 REP-2004 document.
eProsima Micro XRCE-DDS Client is a C99 library that provides a DDS-XRCE implementation for using DDS in eXtreme Resources Constrained Devices. It follows the DDS-XRCE standard.
eProsima Micro XRCE-DDS Client claims to be in the Quality Level 1 category.
Below are the rationales, notes and caveats for this claim, organized by each requirement listed in the Package Requirements for Quality Level 1 in REP-2004.
The Versioning Policy Declaration for eProsima Micro XRCE-DDS Client can be found here and it adheres to semver.
eProsima Micro XRCE-DDS Client is at a stable version, i.e. >=1.0.0.
The latest version and the release notes can be found here.
The public API is documented in oficial documentation Read the Docs.
eProsima Micro XRCE-DDS Client will only break public API between major releases.
Any ABI break in eProsima Micro XRCE-DDS Client will be done between minor versions and it should be clearly stated in the release notes, note that minor releases can happen within a ROS distribution.
The stability of eProsima Micro XRCE-DDS Client is ensured through reviews, CI and tests. The change control process can be found in CONTRIBUTING
All changes to eProsima Micro XRCE-DDS Client occur through pull requests that are required to pass all CI tests. In case of failure, only maintainers can merge the pull request, and only when there is enough evidence that the failure is unrelated to the change. Additionally, all pull requests must have at least one positive review from another contributor that did not author the pull request.
All changes will occur through a pull request.
eProsima Micro XRCE-DDS Client uses the Developer Certificate of Origin (DCO) as its confirmation of contributor origin policy since version 2.0.0. More information can be found in CONTRIBUTING
All pull requests will be peer-reviewed by at least one other contributor who did not author the pull request. Approval is required before merging.
All pull requests must pass CI to be considered for merging, unless maintainers consider that there is enough evidence that the failure is unrelated to the changes. CI testing is automatically triggered by incoming pull requests. Current nightly results for all supported platforms can be checked at the links:
- Linux
- Windows
All pull requests must resolve related documentation changes before merging as stated in CONTRIBUTING.
eProsima Micro XRCE-DDS Client has a documented features list hosted by Read the Docs.
eProsima Micro XRCE-DDS Client includes a complete API Reference which is hosted in Read the Docs.
The license for eProsima Micro XRCE-DDS Client is Apache 2.0, and a summary can be found in each source file. A full copy of the license can be found here.
The eProsima Micro XRCE-DDS Client copyright holder provides a statement of copyright in each source file.
eProsima Micro XRCE-DDS Client provides tests which simulate typical usage, and they are located in the test directory.
New features are required to have tests before being added as stated in CONTRIBUTING.
Current nightly results can be found here:
- Linux
- Windows
Each part of the public API has tests, and new additions or changes to the public API require tests before being added. The tests aim to cover typical usage and corner cases.
eProsima Micro XRCE-DDS Client aims to provide a line coverage above 90%. Micro XRCE-DDS Client code coverage policy comprises:
- All contributions to Micro XRCE-DDS Client must increase (or at least keep) the current line coverage. This is done to ensure that the 90% line coverage goal is eventually met.
- Line coverage regressions are only permitted if properly justified and accepted by maintainers.
- If the CI system reports a coverage regression after a pull request has been merged, the maintainers must study the case and decide how to proceed, most often reverting the changes and asking for a more thorough testing of the committed changes.
- This policy is enforced through the nightly Micro XRCE-DDS Client CI job.
As stated in CONTRIBUTING.md, developers and contributors are required to run a line coverage assessment locally before submitting a PR.
eProsima Micro XRCE-DDS Client does provide performance tests regarding memory consumption due to the nature of the library.
These memory consuption tests are under test/memory and evaluates the static size (text, bss and data sections) of the library built with different configuration profiles.
Also, a stack consumption analysis is provided by using Valgrind Massif tool.
All these results are available in Micro-XRCE-DDS-Client Nightly Master Performance job
Any performance regression detected in eProsima Micro XRCE-DDS Client would be analysed and, in case it is related to eProsima Micro XRCE-DDS Client or could be solved by modifying this library, changes can be made to the library in order to revert the performance regression.
eProsima Micro XRCE-DDS Client code style is enforced using uncrustify. Among the CI tests, there are tests that ensure that every pull request is compliant with the code style. The latest pull request results can be seen here.
eProsima Micro XRCE-DDS Client uses Synopsis Coverity static code analysis.
eProsima Micro XRCE-DDS Client uses CodeQL to find security issues on the code.
eProsima Micro XRCE-DDS Client depends on the following packages:
eProsima Micro CDR
eProsima Micro CDR Quality Declaration can be found here. Currently, eProsima Micro CDR claims to be in the Quality Level 1 category.
eProsima Micro XRCE-DDS Client supports the following platforms and tests each change against all of them as can be seen in the current nightly results:
- Linux
- Windows
More information about the supported platforms can be found in PLATFORM_SUPPORT
eprosima Micro XRCE-DDS Client vulnerability Disclosure Policy can be found here
The chart below compares the requirements in the REP-2004 with the current state of eprosima Micro XRCE-DDS Client
| Number | Requirement | Current State |
|---|---|---|
| 1 | Version policy | --- |
| 1.i | Version Policy available | ✓ |
| 1.ii | Stable version | ✓ |
| 1.iii | Declared public API | ✓ |
| 1.iv | API stability policy | ✓ |
| 1.v | ABI stability policy | ✓ |
| 2 | Change control process | --- |
| 2.i | All changes occur on change request | ✓ |
| 2.ii | Contributor origin (DCO, CLA, etc) | ✓ |
| 2.iii | Peer review policy | ✓ |
| 2.iv | CI policy for change requests | ✓ |
| 2.v | Documentation policy for change requests | ✓ |
| 3 | Documentation | --- |
| 3.i | Per feature documentation | ✓ |
| 3.ii | Per public API item documentation | ✓ |
| 3.iii | Declared License(s) | ✓ |
| 3.iv | Copyright in source files | ✓ |
| 3.v.a | Quality declaration linked to README | ✓ |
| 3.v.b | Centralized declaration available for peer review | ✓ |
| 4 | Testing | --- |
| 4.i | Feature items tests | ✓ |
| 4.ii | Public API tests | ✓ |
| 4.iii.a | Using coverage | ✓ |
| 4.iii.b | Coverage policy | ✓ |
| 4.iv.a | Performance tests (if applicable) | ✓ |
| 4.iv.b | Performance tests policy | ✓ |
| 4.v.a | Code style enforcement (linters) | ✓ |
| 4.v.b | Use of static analysis tools | ✓ |
| 5 | Dependencies | --- |
| 5.iii | Justifies quality use of dependencies | ✓ |
| 6 | Platform support | --- |
| 6.i | Support targets Tier1 ROS platforms | ✓ |
| 7 | Security | --- |
| 7.i | Vulnerability Disclosure Policy | ✓ |