Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: apply autoware_ prefix for duplicated_node_checker #9970

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 19, 2025

Description

This pull request addresses the issue of inconsistent naming by adding the autoware_ prefix to relevant components. This change ensures uniformity across the codebase and aligns with the project's naming conventions.

Related Links

How was this PR tested?

Currently, we only verified that the build succeeds. Further checks will be performed by using the updated module. This PR will be ready for review after finishing all the necessary checks/tests.

Executed Commands (which succeeded)

$ # Around 19:00 JST 21st Jan. 2025
$ vcs import src < autoware-nighty.repos    # Commented out autoware.universe repo
$ rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO
$ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release --packages-up-to autoware_duplicated_node_checker
$ source install/setup.bash 
$ ros2 launch autoware_duplicated_node_checker duplicated_node_checker.launch.xml 
  • Directory Name

    • Add autoware_ as a prefix to the directory name.
  • packages.xml

    • Add autoware_ to the name element.
  • CMakeLists.txt

    • Change the project name to autoware_***.
    • Add autoware:: to PLUGIN.
  • Header Files (.hpp)

    • Start #ifndef guards with AUTOWARE__.
    • Add autoware:: to namespace.
  • Source Files (.cpp)

    • Add autoware:: inside RCLCPP_COMPONENTS_REGISTER_NODE.
  • Launch Files

    • Add autoware_ before find-pkg-share.
    • Change node pkg="<pkgname>" to autoware_<pkgname>.
  • Include

    • Add autoware folder as necessary and update include statements accordingly.
    • Check for impacts on other packages.
  • Verification Points

    • Search find-pkg-share in autoware
    • Check README file (especially json schema)
    • Pay attention to complex cases like sensor_launch as seen in gnss_poser

Notes for Reviewers

None.

Interface Changes

None.

Effects on System Behavior

All the developers who were using duplicated_node_checker needs to modify their code. This is maybe kind of non quick-win task.

  Note:
    * In this commit, I did not organize a folder structure.
      The folder structure will be organized in the next some commits.
    * The changes will follow the Autoware's guideline as below:
        - https://autowarefoundation.github.io/autoware-documentation/main/contributing/coding-guidelines/ros-nodes/directory-structure/#package-folder

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
  * Fixes due to this changes for .hpp/.cpp files will be applied in the next commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
  * To follow the previous commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:system System design and integration. (auto-assigned) labels Jan 19, 2025
Copy link

github-actions bot commented Jan 19, 2025

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@sasakisasaki sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 19, 2025
Copy link

codecov bot commented Jan 19, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 29.46%. Comparing base (b132a88) to head (a68d480).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
..._node_checker/src/duplicated_node_checker_core.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##             main    #9970    +/-   ##
========================================
  Coverage   29.45%   29.46%            
========================================
  Files        1417     1426     +9     
  Lines      107418   107763   +345     
  Branches    42561    42784   +223     
========================================
+ Hits        31643    31752   +109     
- Misses      72698    72950   +252     
+ Partials     3077     3061    -16     
Flag Coverage Δ *Carryforward flag
differential 0.00% <0.00%> (?)
total 29.47% <ø> (+0.01%) ⬆️ Carriedforward from 4a4980e

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 02:33
…ated-node-checker

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…hecker' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-duplicated-node-checker

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added the type:ci Continuous Integration (CI) processes and testing. (auto-assigned) label Jan 22, 2025
…ated-node-checker

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
Copy link
Contributor Author

Finally, I merged the latest main and ran the following command. It seems currently there are ongoing change on the main according to the following error message which is not related to this PR. Including the already performed tests and checks, we would be able to say this PR does not break the dependency on the main.

Command

$ rosdep install -y --from-paths src --ignore-src --rosdistro $ROS_DISTRO

Error Message that Indicates there is ongoing fixes on the main (not related to this PR's fixes)

ERROR: Rosdep experienced an error: Multiple packages found with the same name "autoware_ekf_localizer":
- core/autoware.core/localization/autoware_ekf_localizer
- universe/autoware.universe/localization/autoware_ekf_localizer
Please go to the rosdep page [1] and file a bug report with the stack trace below.
[1] : http://www.ros.org/wiki/rosdep

@sasakisasaki sasakisasaki merged commit 56f29fe into autowarefoundation:main Jan 22, 2025
34 checks passed
sasakisasaki added a commit to sasakisasaki/autoware.universe that referenced this pull request Jan 22, 2025
maxime-clem pushed a commit to maxime-clem/autoware.universe that referenced this pull request Jan 22, 2025
mitsudome-r pushed a commit that referenced this pull request Jan 23, 2025
bug(launch): fix missing changes for following PRs:

  * #9956
  * #9970

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:system System design and integration. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:ci Continuous Integration (CI) processes and testing. (auto-assigned) type:documentation Creating or refining documentation. (auto-assigned)
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants