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 bluetooth_monitor #9960

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

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 18, 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_bluetooth_monitor
$ colcon test --packages-select autoware_bluetooth_monitor
$ colcon test-result --verbose
  • 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 bluetooth_monitor needs to modify their code. This is maybe kind of non quick-win task.

  * 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>
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 18, 2025
Copy link

github-actions bot commented Jan 18, 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 18, 2025
@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 02:30
@sasakisasaki sasakisasaki requested a review from ito-san as a code owner January 20, 2025 02:30
Copy link

codecov bot commented Jan 20, 2025

Codecov Report

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

Project coverage is 29.37%. Comparing base (96708f9) to head (b9c07c8).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
system/autoware_bluetooth_monitor/service/main.cpp 0.00% 1 Missing ⚠️
...toware_bluetooth_monitor/src/bluetooth_monitor.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9960      +/-   ##
==========================================
- Coverage   29.46%   29.37%   -0.10%     
==========================================
  Files        1417     1431      +14     
  Lines      107419   108076     +657     
  Branches    42562    42838     +276     
==========================================
+ Hits        31651    31745      +94     
- Misses      72687    73270     +583     
+ Partials     3081     3061      -20     
Flag Coverage Δ *Carryforward flag
differential 0.00% <0.00%> (?)
total 29.46% <ø> (-0.01%) ⬇️ Carriedforward from 6eb6bcd

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

…oth-monitor

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

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

Successfully merging this pull request may close these issues.

1 participant