Progress toward Quality Level 1

[brawner]

This issue tracks the progression of rcpputils to Quality Level 1 and a 1.0 version level. It follows the outline described in REP 2004.

• Version Policy
  • Follows ROS Core Quality Declaration
• Version >= 1.0.0
• Change Control Process
  • Follows ROS Core
• PRs automatically tested on Jenkins

Documentation

• Per-feature documentation.
  • Features still needing documentation on README.md or equivalent (endian.hpp, filesystem_helper.hpp, find_and_replace.hpp, find_library.hpp, join.hpp, split.hpp, pointer_traits.hpp, visibility_control.hpp)
• Per-item documentation in public API.
  • Items need doc blocks (endian.hpp, filesystem_helper.hpp, thread_safety_annotations.hpp, visibility_control.hpp)
  • Items needing doc improvements (join.hpp)
• Declared set of licenses
• Copyright statement in each source file
  • Incomplete, see Cleanup mislabeled BSD license #37
• Quality Declaration document (Quality declaration #47)

Testing:

• System tests, which cover "features"
• Tests covering public API
• Code coverage (95%)
  • 60%, see Codecov image in README.md j-rivero/rcpputils#2 (comment)
• Performance tests
• Performance test policy: ROS Core
• Package code style: ROS Core
• Uses ament_lint_common

Dependencies:

• Runtime "ROS" dependencies are level 1
  • rcutils
• non-ROS dependencies are equivalent level 1
  • c++ standard library

Platform Support

• Supports all tier 1 platforms

Specific comments:

• filesystem_helper.hpp could attempt to include <filesystem> and use std::filesystem if possible. It's likely Foxy's supported systems already have <filesystem>
• find_and_replace.hpp
  • A regex based solution might have better performance
  • Tests could use more variation
• find_library.hpp
  • Could use more tests
• join.hpp
  • Doc block's description is a little clunky
  • delim could be an optional parameter with a null default
  • Tests could use more variation of containers and value types
• pointer_traits.hpp
  • Tests could use more variation of false cases
• split.hpp
  • is inline necessary?
• thread_safety_annotations.hpp
  • #define statements need documentation
  • Untested defines (RCPPUTILS_TSA_TRY_ACQUIRE, RCPPUTILS_TSA_TRY_ACQUIRE_SHARED, RCPPUTILS_TSA_ACQUIRED_BEFORE, RCPPUTILS_TSA_ACQUIRED_AFTER)
• visibility_control.hpp
  • Needs tests
  • Needs documentation

[chapulina]

Reached level 1: #114