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 component_state_monitor and its dependencies #9961

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

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 humble
$ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=ON --packages-up-to autoware_component_state_monitor autoware_topic_state_monitor autoware_diagnostic_graph_aggregator autoware_system_diagnostic_monitor
$ source install/setup.bash    # Sorry I added this line after the update of this description
$ ros2 launch autoware_component_state_monitor component_state_monitor.launch.py mode:=online file:=src/launcher/autoware_launch/autoware_launch/config/system/component_state_monitor/topics.yaml

(Ctrl + C)

$ ros2 launch autoware_system_diagnostic_monitor system_diagnostic_monitor.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 component_state_monitor needs to modify their code. This is maybe kind of non quick-win task.

  Packages:
    * component_state_monitor
    * diagnostic_graph_aggregator
    * system_diagnostic_monitor
    * topic_state_monitor

  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]>
  * `component_state_monitor` => `autoware_component_state_monitor`
  * `diagnostic_graph_aggregator` => `autoware_diagnostic_graph_aggregator`
  * `system_diagnostic_monitor` => `autoware_system_diagnostic_monitor`
  * `topic_state_monitor` => `autoware_topic_state_monitor`

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
@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 02:26
…ent-state-monitor-and-its-dependencies

Signed-off-by: Junya Sasaki <[email protected]>
Signed-off-by: Junya Sasaki <[email protected]>
Signed-off-by: Junya Sasaki <[email protected]>
…onitor-and-its-dependencies' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-component-state-monitor-and-its-dependencies

Signed-off-by: Junya Sasaki <[email protected]>
@github-actions github-actions bot added type:ci Continuous Integration (CI) processes and testing. (auto-assigned) component:launch Launch files, scripts and initialization tools. (auto-assigned) labels Jan 21, 2025
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 29.66%. Comparing base (9c39d3f) to head (f564b2b).
Report is 10 commits behind head on main.

Files with missing lines Patch % Lines
...stem/autoware_component_state_monitor/src/main.cpp 0.00% 1 Missing ⚠️
...iagnostic_graph_aggregator/src/node/aggregator.cpp 0.00% 1 Missing ⚠️
..._diagnostic_graph_aggregator/src/tool/plantuml.cpp 0.00% 1 Missing ⚠️
...ware_diagnostic_graph_aggregator/src/tool/tree.cpp 0.00% 1 Missing ⚠️
...pic_state_monitor/src/topic_state_monitor_core.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9961      +/-   ##
==========================================
- Coverage   29.79%   29.66%   -0.13%     
==========================================
  Files        1434     1466      +32     
  Lines      108244   109535    +1291     
  Branches    42930    42782     -148     
==========================================
+ Hits        32247    32491     +244     
- Misses      72868    73892    +1024     
- Partials     3129     3152      +23     
Flag Coverage Δ *Carryforward flag
differential 14.49% <0.00%> (?)
total 29.48% <ø> (-0.31%) ⬇️ Carriedforward from 2b78732

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

…onitor-and-its-dependencies' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-component-state-monitor-and-its-dependencies

Signed-off-by: Junya Sasaki <[email protected]>
sasakisasaki and others added 6 commits January 23, 2025 11:32
…ent-state-monitor-and-its-dependencies

Signed-off-by: Junya Sasaki <[email protected]>
…onitor-and-its-dependencies' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-component-state-monitor-and-its-dependencies

Signed-off-by: Junya Sasaki <[email protected]>
Signed-off-by: Takagi, Isamu <[email protected]>
…onitor-and-its-dependencies' of https://github.com/sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-component-state-monitor-and-its-dependencies
Signed-off-by: Takagi, Isamu <[email protected]>
Signed-off-by: Takagi, Isamu <[email protected]>
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.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:launch Launch files, scripts and initialization tools. (auto-assigned) 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
Status: To Triage
Development

Successfully merging this pull request may close these issues.

3 participants