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 diagnostic_graph_utils #9968

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?

This PR is tested with the autoware_internal_msgs with 1.4.0 due to the following error I observed

fatal error: autoware_internal_debug_msgs/msg/string_stamped.hpp: No such file or directory
   22 | #include "autoware_internal_debug_msgs/msg/string_stamped.hpp"
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
gmake[2]: *** [CMakeFiles/autoware_diagnostic_graph_utils_tools.dir/build.make:104: CMakeFiles/autoware_diagnostic_graph_utils_tools.dir/src/node/logging.cpp.o] Error 1
gmake[2]: *** Waiting for unfinished jobs....
gmake[1]: *** [CMakeFiles/Makefile2:171: CMakeFiles/autoware_diagnostic_graph_utils_tools.dir/all] Error 2
gmake: *** [Makefile:146: all] Error 2
---
Failed   <<< autoware_diagnostic_graph_utils [15.3s, exited with code 2]

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 humble
$ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=ON --packages-up-to autoware_diagnostic_graph_utils
  • 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 diagnostic_graph_utils 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 3 lines in your changes missing coverage. Please review.

Project coverage is 29.77%. Comparing base (5872113) to head (5107bcc).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ware_diagnostic_graph_utils/src/node/converter.cpp 0.00% 1 Missing ⚠️
.../autoware_diagnostic_graph_utils/src/node/dump.cpp 0.00% 1 Missing ⚠️
...toware_diagnostic_graph_utils/src/node/logging.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9968      +/-   ##
==========================================
+ Coverage   29.74%   29.77%   +0.02%     
==========================================
  Files        1435     1446      +11     
  Lines      108308   108613     +305     
  Branches    42955    43027      +72     
==========================================
+ Hits        32221    32337     +116     
- Misses      72958    73138     +180     
- Partials     3129     3138       +9     
Flag Coverage Δ *Carryforward flag
differential 14.88% <0.00%> (?)
total 29.78% <ø> (+0.03%) ⬆️ Carriedforward from 3face81

*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:32
Copy link
Contributor

@isamu-takagi isamu-takagi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not change the copyright publication year.

system/autoware_diagnostic_graph_utils/CMakeLists.txt Outdated Show resolved Hide resolved
sasakisasaki and others added 7 commits January 22, 2025 13:33
…stic-graph-utils

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

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
…stic-graph-utils

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>
@github-actions github-actions bot added the component:launch Launch files, scripts and initialization tools. (auto-assigned) label Jan 24, 2025
@github-actions github-actions bot removed the component:launch Launch files, scripts and initialization tools. (auto-assigned) label Jan 24, 2025
mitsudome-r and others added 4 commits January 24, 2025 12:26
Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
…stic_graph_utils

Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
…ostic_graph_utils

Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
@mitsudome-r
Copy link
Member

This has to be merged with tier4/autoware_launch#741

@mitsudome-r mitsudome-r added run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) and removed run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) labels Jan 24, 2025
@mitsudome-r mitsudome-r merged commit ea214c5 into autowarefoundation:main Jan 24, 2025
34 checks passed
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:documentation Creating or refining documentation. (auto-assigned)
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants