This document is a declaration of software quality for the rosidl_typesupport_introspection_c
package, based on the guidelines in REP-2004.
The package rosidl_typesupport_introspection_c
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.
rosidl_typesupport_introspection_c
uses semver
according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
rosidl_typesupport_introspection_c
is at a stable version, i.e. >= 1.0.0. The current version can be found in its package.xml, and its change history can be found in its CHANGELOG.
All symbols in the installed headers are considered part of the public API.
All installed headers are in the include
directory of the package, headers in any other folders are not installed and considered private.
rosidl_typesupport_introspection_c
will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released.
rosidl_typesupport_introspection_c
contains C++ code and therefore must be concerned with ABI stability, and will maintain ABI stability within a ROS distribution.
rosidl_typesupport_introspection_c
follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.
This package requires that all changes occur through a pull request.
This package uses DCO as its confirmation of contributor origin policy. More information can be found in CONTRIBUTING.
Following the recommended guidelines for ROS Core packages, all pull requests must have at least 1 peer review.
All pull requests must pass CI on all tier 1 platforms.
Currently nightly results can be seen here:
All pull requests must resolve related documentation changes before merging.
rosidl_typesupport_introspection_c
has feature documentation and it is publicly hosted.
rosidl_typesupport_introspection_c
has no API documentation.
The license for rosidl_typesupport_introspection_c
is Apache 2.0, and a summary is in each source file, the type is declared in the package.xml manifest file, and a full copy of the license is in the LICENSE file.
There is an automated test which runs a linter that ensures each file has a license statement.
The copyright holders each provide a statement of copyright in each source code file in rosidl_typesupport_introspection_c
.
There is an automated test which runs a linter that ensures each file has at least one copyright statement.
Most recent test results can be found here
rosidl_typesupport_introspection_c
tests validate generated source code rather than the code generator itself. That is, tests verify that both API and ABI of the generated source code enable the expected, relevant use cases. These tests rely on a set of input interface definition files, and a subset of the rosidl
toolchain to generate source code for each of these files.
Each feature provided by rosidl_typesupport_introspection_c
and the source code it generates has corresponding tests according to the rationale outlined in the "Note about tests design" at the beginning of section [4]. These can be found in the rosidl_typesupport_introspection_tests
package.
New features are required to have tests before being added.
Currently nightly test results can be seen here:
The rosidl_typesupport_introspection_c
package does not have tests for its own API. This is a design decision, as detailed in "Note about tests design" at the beginning of section [4]. The rosidl_typesupport_introspection_tests
packages implements such tests.
rosidl_typesupport_introspection_c
follows the recommendations for ROS Core packages in the ROS 2 Developer Guide, and opts to use line coverage instead of branch coverage.
This includes:
- tracking and reporting line coverage statistics
- achieving and maintaining a reasonable branch line coverage (90-100%)
- no lines are manually skipped in coverage calculations
Current coverage statistics can be viewed here. Given the different approach used for testing (detailed in "Note about tests design" at the beginning of section [4]) the pattern to search for rosidl_typesupport_introspection_c
is:
build.rosidl_typesupport_introspection_tests.rosidl_typesupport_introspection_c.rosidl_typesupport_introspection_tests.*
.
APIs in rosidl_typesupport_introspection_c
generated source code provide a thin layer for type-erased access to rosidl
interfaces in C. As such, no useful benchmarks can be devised at the package scope, but rather in the context of a system-wide test (e.g. by benchmarking communication using a middleware implementation that relies on these APIs and it is thus affected by the code structure these induce).
Therefore, this package does not include any performance tests. Refer to the system_tests
repository for system-wide testing.
rosidl_typesupport_introspection_c
uses and passes all the standard linters and static analysis tools for a C package as described in the ROS 2 Developer Guide.
Results of the linting tests can be found here.
rosidl_typesupport_introspection_c
does not have any runtime ROS dependencies.
It has "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code.
rosidl_typesupport_introspection_c
does not have any runtime non-ROS dependencies.
rosidl_typesupport_introspection_c
supports all of the tier 1 platforms as described in REP-2000.
Currently nightly results can be seen here:
This package conforms to the Vulnerability Disclosure Policy in REP-2006.