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

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

sasakisasaki
Copy link

@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.

  • 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 <[email protected]>
  * Fixes due to this changes for .hpp/.cpp files will be applied in the next commit

Signed-off-by: Junya Sasaki <[email protected]>
  * To follow the previous commit

Signed-off-by: Junya Sasaki <[email protected]>
@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.40%. Comparing base (9c0e183) to head (1c7c15b).
Report is 57 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.46%   29.40%   -0.06%     
==========================================
  Files        1444     1450       +6     
  Lines      108703   108922     +219     
  Branches    42492    42529      +37     
==========================================
  Hits        32031    32031              
- Misses      73582    73801     +219     
  Partials     3090     3090              
Flag Coverage Δ *Carryforward flag
differential 0.00% <0.00%> (?)
total 29.46% <ø> (ø) Carriedforward from 9c0e183

*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.

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
Status: To Triage
Development

Successfully merging this pull request may close these issues.

1 participant