[ros2pkg] Skip copyright tests in template packages #676

aprotyas · 2021-11-30T05:21:45Z

The template sources populated through ros2 pkg create for the
ament_python/ament_cmake build types do not have well-formed
copyright headers, and as such fail the ament_copyright tests when
run as-is.

This commit skips said test by default, instead informing the user to -
once the source files have been populated with well-formed headers -
enable the skipped tests either within the test script itself (for
ament_python) or within the CMakeLists.txt file (for ament_cmake).

Addresses #675.

Signed-off-by: Abrar Rahman Protyasha aprotyas@u.rochester.edu

The template sources populated through `ros2 pkg create` for the `ament_python` build type do not have a well-formed copyright header, and as such fail the `ament_copyright` test when run as-is. This commit skips said test by default, instead informing the user to remove the `skip` decorator once they've populated their sources with the proper copyright headers. Signed-off-by: Abrar Rahman Protyasha <aprotyas@u.rochester.edu>

The template sources populated through `ros2 pkg create` for the `ament_cmake` build type do not have a well-formed copyright header and the package itself does not have a proper license file. As such, the copyright and cpplint linters report missing license/copyright problems with the generated package. This commit skips said tests by default, instead informing the user to comment out the lines which allow the copyright and cpplint linter checks to be skipped once license/copyright headers are placed in the package appropriately. Signed-off-by: Abrar Rahman Protyasha <aprotyas@u.rochester.edu>

aprotyas · 2021-11-30T05:32:17Z

For reviewers, it's unfortunate that the cpplint test has to be skipped for the ament_cmake package, but the alternative to that is excluding ament_cmake_cpplint from ament_lint_auto, and then invoking ament_cpplint separately in the CMakeLists.txt file with the -legal/copyright filter. This is awkward and would add too much noise for a beginner-friendly template.