feat: apply `autoware_` prefix for `vehicle_door_simulator` #9997

sasakisasaki · 2025-01-21T10:33:48Z

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.

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_vehicle_door_simulator

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 vehicle_door_simulator 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]>

Signed-off-by: Junya Sasaki <[email protected]>

github-actions · 2025-01-21T10:34:06Z

Thank you for contributing to the Autoware project!

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

Please ensure:

You've checked our contribution guidelines.
Your PR follows our pull request guidelines.
All required CI checks pass before marking the PR ready for review.

isamu-takagi · 2025-01-21T10:53:21Z

simulator/autoware_vehicle_door_simulator/src/dummy_doors.cpp

@@ -16,10 +16,10 @@

 #include <memory>

-namespace vehicle_door_simulator
+namespace autoware::simulator::vehicle_door_simulator


No component name "simulator" needed

Thank you, and sorry for my silly mistake in this namespace issue. I'll fix and push soon.

Fixed by this commit

isamu-takagi · 2025-01-21T10:53:55Z

simulator/autoware_vehicle_door_simulator/src/dummy_doors.cpp

 {

-DummyDoors::DummyDoors() : Node("dummy_doors")
+DummyDoors::DummyDoors() : Node("autoware_vehicle_door_simulator_node")


Node name do not need the autoware prefix

Thank you, I'll also apply the fix for the other PRs.

Fixed by this commit

Signed-off-by: Junya Sasaki <[email protected]>

…me in the namespace Signed-off-by: Junya Sasaki <[email protected]>

…d here Signed-off-by: Junya Sasaki <[email protected]>

codecov · 2025-01-22T05:07:13Z

Codecov Report

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

Project coverage is 29.44%. Comparing base (56f29fe) to head (511a115).
Report is 15 commits behind head on main.

Files with missing lines	Patch %	Lines
...utoware_vehicle_door_simulator/src/dummy_doors.cpp	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9997      +/-   ##
==========================================
- Coverage   29.66%   29.44%   -0.22%     
==========================================
  Files        1433     1418      -15     
  Lines      108151   107471     -680     
  Branches    42894    42566     -328     
==========================================
- Hits        32082    31649     -433     
+ Misses      72960    72741     -219     
+ Partials     3109     3081      -28

Flag	Coverage Δ		*Carryforward flag
differential	`0.00% <0.00%> (?)`
total	`29.46% <ø> (-0.20%)`	⬇️	Carriedforward from 198cda9

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

SakodaShintaro

autoware.universe/launch/tier4_simulator_launch/launch/simulator.launch.xml

Line 206 in f36d072

    
           <include file="$(find-pkg-share vehicle_door_simulator)/launch/vehicle_door_simulator.launch.xml"/>

I have never used launch_dummy_doors=true but it seems to need to be fixed.

…icle-door-simulator Signed-off-by: Junya Sasaki <[email protected]>

Signed-off-by: Junya Sasaki <[email protected]>

…imulator' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-simulator-vehicle-door-simulator Signed-off-by: Junya Sasaki <[email protected]>

isamu-takagi

LGTM

SakodaShintaro

LGTM

sasakisasaki added 3 commits January 21, 2025 19:20

rename: vehicle_door_simulator => autoware_vehicle_door_simulator

ae7dcad

Signed-off-by: Junya Sasaki <[email protected]>

fix(autoware_vehicle_door_simulator): update CODEOWNERS

9d65527

Signed-off-by: Junya Sasaki <[email protected]>

sasakisasaki requested a review from mitsudome-r January 21, 2025 10:34

github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) type:ci Continuous Integration (CI) processes and testing. (auto-assigned) component:simulation Virtual environment setups and simulations. (auto-assigned) labels Jan 21, 2025

sasakisasaki requested review from SakodaShintaro and rej55 January 21, 2025 10:34

sasakisasaki marked this pull request as ready for review January 21, 2025 10:34

sasakisasaki requested a review from isamu-takagi as a code owner January 21, 2025 10:34

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

style(pre-commit): autofix

18fdcaf

isamu-takagi reviewed Jan 21, 2025

View reviewed changes

sasakisasaki added 3 commits January 21, 2025 20:02

bug(autoware_vehicle_door_simulator): fix a wrong header guard

5bec528

Signed-off-by: Junya Sasaki <[email protected]>

fix(autoware_vehicle_door_simulator): do not contain its component na…

04aeede

…me in the namespace Signed-off-by: Junya Sasaki <[email protected]>

fix(autoware_vehicle_door_simulator): autoware_ prefix is not neede…

1b0c181

…d here Signed-off-by: Junya Sasaki <[email protected]>

sasakisasaki requested a review from isamu-takagi January 21, 2025 11:07

style(pre-commit): autofix

198cda9

SakodaShintaro requested changes Jan 22, 2025

View reviewed changes

sasakisasaki added 3 commits January 22, 2025 17:48

Merge branch 'main' into feat-apply-autoware-prefix-for-simulator-veh…

74dc698

…icle-door-simulator Signed-off-by: Junya Sasaki <[email protected]>

bug(autoware_vehicle_door_simulator): fix a wrong package name

bcde8b0

Signed-off-by: Junya Sasaki <[email protected]>

Merge branch 'feat-apply-autoware-prefix-for-simulator-vehicle-door-s…

511a115

…imulator' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-simulator-vehicle-door-simulator Signed-off-by: Junya Sasaki <[email protected]>

sasakisasaki requested review from KeisukeShima, taikitanaka3, TakaHoribe, takayuki5168 and tkimura4 as code owners January 22, 2025 08:52

github-actions bot added the component:launch Launch files, scripts and initialization tools. (auto-assigned) label Jan 22, 2025

isamu-takagi approved these changes Jan 22, 2025

View reviewed changes

SakodaShintaro approved these changes Jan 23, 2025

View reviewed changes

mitsudome-r merged commit 9c39d3f into autowarefoundation:main Jan 23, 2025
34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: apply `autoware_` prefix for `vehicle_door_simulator` #9997

feat: apply `autoware_` prefix for `vehicle_door_simulator` #9997

sasakisasaki commented Jan 21, 2025

github-actions bot commented Jan 21, 2025 •

edited

Loading

isamu-takagi Jan 21, 2025

sasakisasaki Jan 21, 2025

sasakisasaki Jan 21, 2025

isamu-takagi Jan 21, 2025

sasakisasaki Jan 21, 2025

sasakisasaki Jan 21, 2025

codecov bot commented Jan 22, 2025 •

edited

Loading

SakodaShintaro left a comment

isamu-takagi left a comment

SakodaShintaro left a comment

feat: apply autoware_ prefix for vehicle_door_simulator #9997

feat: apply autoware_ prefix for vehicle_door_simulator #9997

Conversation

sasakisasaki commented Jan 21, 2025

Description

Related Links

How was this PR tested?

Executed Commands (which succeeded)

Notes for Reviewers

Interface Changes

Effects on System Behavior

github-actions bot commented Jan 21, 2025 • edited Loading

isamu-takagi Jan 21, 2025

Choose a reason for hiding this comment

sasakisasaki Jan 21, 2025

Choose a reason for hiding this comment

sasakisasaki Jan 21, 2025

Choose a reason for hiding this comment

isamu-takagi Jan 21, 2025

Choose a reason for hiding this comment

sasakisasaki Jan 21, 2025

Choose a reason for hiding this comment

sasakisasaki Jan 21, 2025

Choose a reason for hiding this comment

codecov bot commented Jan 22, 2025 • edited Loading

Codecov Report

SakodaShintaro left a comment

Choose a reason for hiding this comment

isamu-takagi left a comment

Choose a reason for hiding this comment

SakodaShintaro left a comment

Choose a reason for hiding this comment

feat: apply `autoware_` prefix for `vehicle_door_simulator` #9997

feat: apply `autoware_` prefix for `vehicle_door_simulator` #9997

github-actions bot commented Jan 21, 2025 •

edited

Loading

codecov bot commented Jan 22, 2025 •

edited

Loading