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 control_performance_analysis #9982

Merged
merged 20 commits into from
Jan 24, 2025
Merged

feat: apply autoware_ prefix for control_performance_analysis #9982

merged 20 commits into from
Jan 24, 2025

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 20, 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 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_control_performance_analysis
$ source install/setup.bash
$ ros2 launch autoware_control_performance_analysis control_performance_analysis.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 control_performance_analysis needs to modify their code. This is maybe kind of non quick-win task.

@sasakisasaki
feat(control_performance_analysis): apply autoware_ prefix (see bel…
58c0925 
…ow):

  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(control_performance_analysis): move headers under `include/aut…
fdbec48 
…oware`:

  * 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(control_performance_analysis): fix include paths
a7c670a 
  * To follow the previous commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
rename: control_performance_analysis => `autoware_control_performan…
914ab58 
…ce_analysis`

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:control Vehicle control algorithms and mechanisms. (auto-assigned) labels Jan 20, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 20, 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 sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 20, 2025
@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 06:29
@codecov Codecov
Copy link

codecov bot commented Jan 20, 2025 •
edited
Loading

Codecov Report

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

Project coverage is 29.40%. Comparing base (8b0b9a7) to head (52efbcf).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...analysis/src/control_performance_analysis_core.cpp 0.00% 7 Missing ⚠️
...analysis/src/control_performance_analysis_node.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #9982      +/-   ##
==========================================
- Coverage   29.78%   29.40%   -0.38%     
==========================================
  Files        1436     1430       -6     
  Lines      108308   108047     -261     
  Branches    42956    42806     -150     
==========================================
- Hits        32256    31769     -487     
- Misses      72920    73214     +294     
+ Partials     3132     3064      -68
Flag Coverage Δ *Carryforward flag
differential 0.00% <0.00%> (?)
total 29.49% <ø> (-0.29%) ⬇️ Carriedforward from e0153d9

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

sasakisasaki and others added 5 commits January 22, 2025 20:47
@sasakisasaki
Merge branch 'main' into feat-apply-autoware-prefix-for-control-contr…
99eed53 
…ol-performance-analysis

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
Merge branch 'feat-apply-autoware-prefix-for-control-control-performa…
3486a40 
…nce-analysis' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-control-control-performance-analysis

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
bug(autoware_control_performance_analysis): fix inconsistent namespacing
f31b17b 
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@pre-commit-ci
style(pre-commit): autofix
3801993
@sasakisasaki
update(autoware_control_performance_analysis): README.md
648a771 
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
Copy link
Contributor Author

sasakisasaki commented Jan 22, 2025 •
edited
Loading

[JFYI] @takayuki5168 Thank you for your review. I applied some proposed improvements (provided in other PRs) and tested this PR again. I believe the applied changes after the approval do not contaminate the main branch. If you find anything for the improvement, any ideas are welcome and appreciated. Thanks!

sasakisasaki and others added 4 commits January 23, 2025 16:58
@sasakisasaki
bug(autoware_control_performance_analysis): fix critical bugs that co…
1f763f4 
…ntaminate topic name

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
Merge branch 'feat-apply-autoware-prefix-for-control-control-performa…
37553cd 
…nce-analysis' of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-control-control-performance-analysis

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@pre-commit-ci
style(pre-commit): autofix
3813b10
@sasakisasaki
Merge branch 'main' into feat-apply-autoware-prefix-for-control-contr…
46e3fd6 
…ol-performance-analysis
@mitsudome-r
fix: update package name for error_rqt_multiplot.xml
a484b66 
Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
@mitsudome-r
fix: update package name for control_performance_plot.py
87ce593 
Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
@mitsudome-r
docs(autoware_control_performance_analysis): update package name in R…
1c7278b 
…EADME and CHANGELOG.rst

Signed-off-by: Ryohsuke Mitsudome <ryohsuke.mitsudome@tier4.jp>
@SakodaShintaro
Copy link
Contributor

I have tested:

@SakodaShintaro SakodaShintaro enabled auto-merge (squash) January 24, 2025 04:05
@SakodaShintaro SakodaShintaro added run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) and removed run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) labels Jan 24, 2025
@SakodaShintaro SakodaShintaro merged commit ecc93f1 into autowarefoundation:main Jan 24, 2025
40 of 42 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

@mitsudome-r mitsudome-r mitsudome-r approved these changes

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

@satoshi-ota satoshi-ota Awaiting requested review from satoshi-ota satoshi-ota is a code owner

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

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

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

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

Assignees
No one assigned
Labels
component:control Vehicle control algorithms and mechanisms. (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
Software Working Group
Archived in project
Milestone
No milestone
Development

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