Initial tests - Githubissues

hello-robot / stretch_ros2

ROS 2 packages for the Stretch mobile manipulators from Hello Robot Inc.

https://docs.hello-robot.com/0.2/stretch-tutorials/ros2/

52 stars 20 forks source link

Initial tests #4

Closed DLu closed 2 years ago

DLu commented 2 years ago

Adds copyright headers to all Python files in stretch_core (and runs the copyright header test)
- strech_description is licensed with CC BY-NC-SA 4.0 (Attribution-NonCommercial-ShareAlike 4.0 International) so I wasn't sure what header to put.
Adds both standard linters (pep257/flake8) to stretch_core and stretch_description.
- Currently the tests pass for the ported files, namely
  - stretch_core/launch/stretch_driver.launch.py
  - stretch_core/stretch_core/*.py
  - All of stretch_description/

As the additional code gets ported, it will be linted as we go.

hello-binit commented 2 years ago

Thank you for opening this PR @DLu! For now, let's just add the test files and not worry about changing the source files to make the linting/copyrighting tests pass. We can modify the lint rules to allow longer line lengths, and I think it would be verbose to include a copyright header in each source file when we already have a "license.md" in each package's directory.

I think the main benefit of starting a "test/" folder is that we can begin to write functional and performance tests as we go along to ensure correctness and reproducibility.

DLu commented 2 years ago

@hello-binit I've added a configuration file to use a much more generous line length and rolled back some of the changes.

I also had it ignore the nonported files for now.

As far as the copyright goes, currently the ament_copyright module doesn't support per-package LICENSE texts and even if it is in the repo root, the copyright test will still just check that the LICENSE file matches one of the given licenses, and then still report all the files that don't have individual headers.

hello-binit commented 2 years ago

Thanks @DLu, it's in!