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.

Sign up for GitHub

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

Jump to bottom

feat: apply autoware_ prefix for simple_planning_simulator #9995

Merged
merged 15 commits into from
Jan 23, 2025
Merged

feat: apply autoware_ prefix for simple_planning_simulator #9995

merged 15 commits into from
Jan 23, 2025

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 21, 2025 •
edited
Loading

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 14:00 JST 21st Jan. 2025
$ vcs import src < autoware-nighty.repos    # Commented out autoware.universe repo
$ # Fix duplicated packages issue
$ rm -fr src/core/autoware.core/localization/autoware_ekf_localizer src/core/autoware.core/common/autoware_kalman_filter src/core/autoware.core/localization/autoware_localization_util src/core/autoware.core/common/autoware_osqp_interface src/core/autoware.core/common/autoware_qp_interface
$ 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_simple_planning_simulator autoware_raw_vehicle_cmd_converter

  • 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 simple_planning_simulator needs to modify their code. This is maybe kind of non quick-win task.

@sasakisasaki
feat(simple_planning_simulator): apply autoware_ prefix (see below):
7756092 
  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>
@sasakisasaki
rename(simple_planning_simulator): move headers under `include/autowa…
83b6d7b 
…re`:

  * 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>
@sasakisasaki
fix(simple_planning_simulator): fix include header paths
1d6dde9 
  * To follow the previous commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
rename: simple_planning_simulator => `autoware_simple_planning_simu…
24ec483 
…lator`

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:launch Launch files, scripts and initialization tools. (auto-assigned) component:simulation Virtual environment setups and simulations. (auto-assigned) labels Jan 21, 2025
@github-actions GitHub Actions
Copy link

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

Thank you for contributing to the Autoware project!

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

Please ensure:

@sasakisasaki
bug(autoware_simple_planning_simulator): fix missing changes
a695d9f 
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
@sasakisasaki
Merge branch 'main' into feat-apply-autoware-prefix-for-simulator-sim…
37bab2a 
…ple-planning-simulator

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki sasakisasaki marked this pull request as ready for review January 21, 2025 09:11
@sasakisasaki sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 21, 2025
@sasakisasaki sasakisasaki requested a review from rej55 January 21, 2025 09:12
@sasakisasaki sasakisasaki marked this pull request as draft January 21, 2025 09:20
@sasakisasaki
Copy link
Contributor Author

Sorry, I found that the commands I ran has an issue (not clean build). Let me fix the issue.

@sasakisasaki
Copy link
Contributor Author

Oh, I was also missing running the test code, ... . Fixes will be pushed soon.

@sasakisasaki
bug(autoware_simple_planning_simulator): fix errors in build and tests
99bb143 
  * I had to run after `rm -rf install build`, ... sorry

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
Merge branch 'feat-apply-autoware-prefix-for-simulator-simple-plannin…
60fda10 
…g-simulator' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-simulator-simple-planning-simulator

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki sasakisasaki marked this pull request as ready for review January 21, 2025 09:36
@sasakisasaki
Copy link
Contributor Author

Now ready to review!

takayuki5168
takayuki5168 approved these changes Jan 21, 2025
View reviewed changes
Copy link
Contributor

@takayuki5168 takayuki5168 left a comment

Choose a reason for hiding this comment

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

Please make sure to confirm that the planning simulator works well.

@codecov Codecov
Copy link

codecov bot commented Jan 21, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 30.17%. Comparing base (82c9470) to head (6c4e58c).
Report is 6 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #9995      +/-   ##
==========================================
+ Coverage   29.76%   30.17%   +0.40%     
==========================================
  Files        1434     1447      +13     
  Lines      108244   109078     +834     
  Branches    42930    43149     +219     
==========================================
+ Hits        32222    32917     +695     
- Misses      72893    73027     +134     
- Partials     3129     3134       +5
Flag Coverage Δ *Carryforward flag
differential 27.56% <100.00%> (?)
total 29.47% <ø> (-0.30%) ⬇️ Carriedforward from 92894f4

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

Please check "pre-commit.ci - pr"
https://results.pre-commit.ci/run/github/429651616/1737452518.Cup7xXzCSqSXeMX_XDlHzA

@SakodaShintaro
Fixed NOLINT
24bfbf3 
Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp>
@SakodaShintaro SakodaShintaro mentioned this pull request Jan 23, 2025
Merged
@SakodaShintaro
Merge branch 'main' into feat-apply-autoware-prefix-for-simulator-sim…
aa0882b 
…ple-planning-simulator
@SakodaShintaro
Added NOLINT
2e28743 
Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp>
@SakodaShintaro
Merge remote-tracking branch 'origin' into feat-apply-autoware-prefix…
92894f4 
…-for-simulator-simple-planning-simulator

Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp>
@SakodaShintaro
Fixed to autoware_simple_planning_simulator
6c4e58c 
Signed-off-by: Shintaro Sakoda <shintaro.sakoda@tier4.jp>
@SakodaShintaro SakodaShintaro merged commit 1a1a18a into autowarefoundation:main Jan 23, 2025
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@takayuki5168 takayuki5168 takayuki5168 approved these changes

@soblin soblin soblin approved these changes

@maxime-clem maxime-clem Awaiting requested review from maxime-clem maxime-clem is a code owner

@TakaHoribe TakaHoribe Awaiting requested review from TakaHoribe TakaHoribe is a code owner

@xtk8532704 xtk8532704 Awaiting requested review from xtk8532704 xtk8532704 is a code owner

@tkimura4 tkimura4 Awaiting requested review from tkimura4 tkimura4 is a code owner

@zulfaqar-azmi-t4 zulfaqar-azmi-t4 Awaiting requested review from zulfaqar-azmi-t4 zulfaqar-azmi-t4 is a code owner

@HansRobo HansRobo Awaiting requested review from HansRobo HansRobo is a code owner

@KeisukeShima KeisukeShima Awaiting requested review from KeisukeShima KeisukeShima is a code owner

@taikitanaka3 taikitanaka3 Awaiting requested review from taikitanaka3 taikitanaka3 is a code owner

@rej55 rej55 Awaiting requested review from rej55

Assignees
No one assigned
Labels
component:launch Launch files, scripts and initialization tools. (auto-assigned) component:simulation Virtual environment setups and simulations. (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
Software Working Group
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sasakisasaki @SakodaShintaro @takayuki5168 @soblin